Webhooks hérités sur Legalesign

Que sont les webhooks hérités

Les webhooks hérités sont notre ancien système de webhooks. Si vous envisagez d'utiliser les webhooks pour la première fois, utilisez le système plus récent - nouveaux webhooks

Nous continuerons à supporter les webhooks hérités dans un avenir prévisible afin d'assurer la compatibilité rétroactive. Si cela change, vous recevrez de nombreuses notifications. Nous vous recommandons néanmoins de faire la mise à jour, car les webhooks en temps réel sont déclenchés pour plus d'événements, contiennent des informations plus utiles, peuvent être filtrés plus efficacement et se produisent plus rapidement.

Types de webhook

Il existe deux types de webhooks hérités.

• Lors d'un [événement] (déprécié)
• Tous les événements toutes les 6 minutes (déprécié)

Comment ajouter ou supprimer un webhook

Ajouter ou supprimer via l'application Web

Allez dans paramètres et vous verrez le panneau des webhooks. Le formulaire dispose de contrôles simples pour ajouter ou supprimer des webhooks

danger

Votre clé API est basée sur votre compte et non un groupe ou organisation individuel. Cela donne plus de flexibilité à votre clé API, mais vos webhooks recevront des informations de tous les comptes où vous êtes administrateur, en développement comme en production. Pour différencier les webhooks par groupe, utilisez soit le filtre, soit (méthode ancienne) créez un nouvel utilisateur admin qui n'est membre que du ou des groupes ciblés, obtenez-lui une clé API, et utilisez ce compte pour votre webhook.

Ajouter ou supprimer via l'API

Utilisez de simples requêtes GET et POST via l'API REST pour lister, créer ou supprimer des webhooks.

Pour plus d'informations, consultez la documentation : API webhooks

Le format d'un webhook 'Lors de ...'

Ce sont des webhooks déclenchés pour un événement spécifique - signature, création, rejet ou visite échouée.

Ils sont envoyés sous forme de requêtes POST à votre URL.

Ils contiennent le nom du document, le code de l'événement, l'URI ressource, les tags et l'UUID du document. Voici la capture d'écran depuis ngrok.

Le format d'un webhook de mise à jour générale / toutes les 6 minutes

L'appel toutes les 6 minutes ressemble à ceci :

Comme vous pouvez le voir, c'est aussi une requête POST. Mais cette fois toutes les informations sont stockées dans l'attribut POST 'data' sous forme d'objet JSON.

Voici en détail cet objet JSON :

[
  {
    "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"
  }
]

Que se passe-t-il ici ? Le webhook de mise à jour générale vous donne désormais tous les détails sur ce qui s'est passé lors de la signature d'un document, et quand. Il inclut des mises à jour d'événements pour le signataire comme pour le document.

attention

Vous aurez remarqué que nous utilisons les mots « destinataire » et « signataire ». Ils sont interchangeables. L'utilisation de destinataire reflète les rôles plus complexes désormais disponibles dans Legalesign et deviendra le nouveau terme pour « signataire » au fur et à mesure de notre développement.

L'histoire de ces données webhook est que l'objet signataire a été créé (signataire 5), envoyé (signataire 10), le signataire a complété son champ (signataire 30), et signé (signataire 40), le document a noté que ses champs étaient complets (document 20), a ensuite été marqué comme signé (document 30), puis prêt à être téléchargé (document 100).

'100' est un code d'événement spécial qui confirme qu'un document est prêt à être téléchargé.

Statut du document

Statut	Explication
10	Envoyé
20	Champs complétés
30	Complet
40	Retiré (avant la signature)
50	Rejeté

Statut du signataire

Statut	Explication
4	Non envoyé
5	Programmé pour envoi
10	Envoyé
15	Email ouvert
20	Visité
30	Champs complétés
35	Champs faits sauf les champs signature
39	Témoin pour signature
40	Terminé
50	Téléchargé
60	Rejeté

Déboguer les webhooks dans le tableau de bord API

Tous les webhooks sont enregistrés et vous pouvez examiner leur contenu ainsi que le code de statut HTTP dans votre tableau de bord API. Pour en savoir plus, consultez le Tutoriel du tableau de bord

Accédez directement au tableau de bord API.

Contactez-nous

Cela couvre tout ce que vous devez savoir sur les webhooks hérités.

Si vous avez d'autres questions, n'hésitez pas à nous contacter - support.legalesign.com.