Signer Webhooks

Ce webhook est reçu lorsqu'un événement lié à un signataire est déclenché.

L'objet global reçu - [type : IgnisignWebhook_ActionDto]

C'est l'objet global qui est POST à votre application lorsqu'un événement webhook est déclenché.

champ	type	requis	description
topic	String	Oui	Valeur fixe : "SIGNER"
action	IGNISIGN_WEBHOOK_ACTION_SIGNER	Oui	L'action associée à l'événement webhook
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Oui	Le type de message
content	IgnisignWebhookDto_Signer	Non	Le contenu du webhook
error	IgnisignError	Non	L'erreur éventuelle
appId	string	Oui	L'appId associée à l'événement
appEnv	IGNISIGN_APPLICATION_ENV	Oui	L'appEnv associée à l'événement
verificationToken	string	Oui	Un jeton qui peut être utilisé pour vérifier que le webhook provient d'ignisign

Les SDKs traitent automatiquement ces appels et vous fournissent un mécanisme d'enregistrement de callback pour les événements typés.

Lorsque vous utilisez les SDKs :

• Le verificationToken est automatiquement vérifié.
• L'appId et l'appEnv sont automatiquement vérifiés.
• Seuls topic, action, msgNature, content et error sont disponibles dans les callbacks.

L'objet Content : [type: IgnisignWebhookDto_Signer]

champ	type	requis	description
appId	string	Oui	L'appId associée à l'événement
appEnv	IGNISIGN_APPLICATION_ENV	Oui	L'appEnv associée à l'événement
signerId	string	Oui	L'id du signataire associé à la signature
signerExternalId	string	Non	Une référence externe (votre référence) si vous l'avez fournie lors de la création du signataire
inputsAdded	liste de IGNISIGN_SIGNER_CREATION_INPUT_REF	non	Fourni lorsqu'une entrée est ajoutée à un signataire. Non déclenché lors de la création du signataire

L'objet Error : [type: IgnisignError]

champ	type	requis	description
errorCode	IGNISIGN_ERROR_CODES	oui	Le code d'erreur
message	string	non	Un message lisible décrivant l'erreur
context	object (any)	non	Une carte de paires clé-valeur fournissant un contexte supplémentaire à l'erreur

Énumérations associées :

• IGNISIGN_WEBHOOK_ACTION_SIGNER :

  • CREATED : déclenché lorsqu'un signataire est créé
  • INPUTS_ADDED : déclenché lorsque des entrées sont ajoutées à un signataire

• IGNISIGN_SIGNER_CREATION_INPUT_REF :

  • firstName : Un prénom est ajouté au signataire
  • lastName : Un nom de famille est ajouté au signataire
  • email : Un email est ajouté au signataire
  • phoneNumber : Un numéro de téléphone est ajouté au signataire
  • nationality : La nationalité du signataire a été ajoutée
  • birthDate : La date de naissance du signataire a été ajoutée
  • birthPlace : Le lieu de naissance du signataire a été ajouté
  • birthCountry : Le pays de naissance du signataire a été ajouté

• IGNISIGN_WEBHOOK_MESSAGE_NATURE: Représente la nature ou le type d'un message associé à un événement webhook dans l'application Ignisign.

  • INFO : Le message est fourni pour donner des informations (par exemple, une mise à jour de statut)
  • SUCCESS : Le message est lié à un succès (par exemple, une session de signature est terminée)
  • WARNING : Le message est lié à un avertissement (une action est terminée mais avec des avertissements)
  • ERROR : Le message est lié à une erreur (une action a échoué)