Webhooks heredados en Legalesign

Qué son los webhooks heredados

Los webhooks heredados son nuestro sistema de webhooks más antiguo. Si estás pensando en usar webhooks por primera vez, usa el sistema más nuevo - nuevos webhooks

Continuaremos apoyando los webhooks heredados en el futuro previsible para asegurar la compatibilidad hacia atrás. Si eso cambia, recibirás suficiente aviso. Recomendamos que actualices de todos modos, los webhooks en tiempo real se activan para más eventos, contienen información más útil, pueden filtrarse más eficazmente y ocurren más rápido.

Tipos de webhook

Existen dos tipos de webhook heredados.

• Al [evento] (obsoleto)
• Todos los eventos cada 6 minutos (obsoleto)

Cómo agregar o eliminar un webhook

Agregar o eliminar usando la aplicación web

Ve a settings y verás el panel de webhooks. El formulario tiene controles sencillos para agregar o eliminar webhooks

peligro

Tu clave API está basada en tu cuenta y no en un grupo u organización individual. Esto le da más flexibilidad a tu clave API, pero tus webhooks recibirán información de todas las cuentas donde eres administrador, tanto de desarrollo como de producción. Para diferenciar webhooks por grupo, usa el filtro o (el método antiguo) crea un nuevo usuario administrador que solo sea miembro dentro del/los grupo(s) objetivo, obtén su clave API y usa esa cuenta para tu webhook.

Agregar o eliminar usando la API

Usa solicitudes simples GET y POST sobre la REST API para listar, crear o eliminar webhooks.

Para más información, consulta la documentación: API webhooks

El formato de un webhook 'Al ...'

Estos son webhooks activados para un evento específico - firma, creación, rechazo o una visita fallida.

Se entregan como solicitudes POST a tu url.

Estos contienen el nombre del documento, código del evento, uri del recurso, etiquetas y uuid del documento. Aquí está el printout desde ngrok.

El formato de un webhook general de actualización / cada 6 minutos

La llamada de 6 minutos se ve así:

Como puedes ver, también es una solicitud POST. Pero esta vez toda la información está almacenada en el atributo POST 'data' como un objeto JSON.

Aquí está ese objeto JSON en detalle:

[
  {
    "value": "5",
    "timestamp": "2022-07-11T07:28:25+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "10",
    "timestamp": "2022-07-11T07:28:26+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:28:55+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "40",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "100",
    "timestamp": "2022-07-11T07:29:09+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  }
]

¿Qué está pasando aquí? El webhook de actualización general ahora te brinda todos los detalles sobre lo que ocurrió en la firma de un documento y cuándo. Incluye actualizaciones de eventos tanto para un firmante como para un documento.

aviso

Será notorio que usamos las palabras 'recipient' y 'signer'. Son intercambiables. El uso de recipient refleja los roles más complejos que ahora están disponibles en Legalesign y será el nuevo nombre para 'signer' a medida que desarrollemos.

La historia de estos datos del webhook es que el objeto signer se creó (signer 5), se envió (signer 10), el firmante completó su campo (signer 30) y firmó (signer 40), el documento indicó que sus campos estaban completos (document 20), luego fue marcado como firmado (document 30) y luego listo para descargar (document 100).

'100' es un código de evento especial para confirmar que un documento está listo para descargar.

Estado del documento

Estado	Explicación
10	Enviado
20	Campos completados
30	Completo
40	Removido (antes de firmar)
50	Rechazado

Estado del firmante

Estado	Explicación
4	No enviado
5	Programado para enviar
10	Enviado
15	Correo abierto
20	Visitado
30	Campos completados
35	Campos completados excepto firmas
39	Testigo para firmar
40	Completado
50	Descargado
60	Rechazado

Depura webhooks en el panel de API

Todos los webhooks se registran y puedes examinar su contenido y el código de estado http en tu panel de API. Para aprender más, consulta el tutorial del panel

Ir directamente al panel de API.

Contáctanos

Eso cubre todo lo que necesitas saber sobre los webhooks heredados.

Si tienes más preguntas, por favor ponte en contacto - support.legalesign.com.