Images de Signature

Ce webhook est reçu lorsque des événements liés aux images de signature sont déclenchés.

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 : "SIGNATURE_IMAGE"
action	IGNISIGN_WEBHOOK_ACTION_SIGNATURE_IMAGE	Oui	L'action associée à l'événement webhook
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Oui	Le type de message
content	IgnisignWebhookDto_SignatureImage	Non	Le contenu du webhook
error	IgnisignError	Non	L'erreur éventuelle
appId	string	Oui	L'appId associé à l'événement
appEnv	IGNISIGN_APPLICATION_ENV	Oui	L'appEnv associé à 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é.
• Les appId et appEnv sont automatiquement vérifiés.
• Seuls topic, action, msgNature, content et error sont disponibles dans les callbacks.

L'objet Content : [type: IgnisignWebhookDto_SignatureImage ]

champ	type	requis	description
appId	string	Oui	L'appId associé à l'événement
appEnv	IGNISIGN_APPLICATION_ENV	Oui	L'appEnv associé à l'événement
signatureRequestId	string	Oui	L'id de la demande de signature associée à la signature
signatureRequestExternalId	string	Non	Une référence externe (votre référence) si vous l'avez fournie lors de la création de la demande de signature
documentId	string	Oui	L'id du document associé à la signature
documentExternalId	string	Non	Une référence externe (votre référence) si vous l'avez fournie lors de la création du document
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

L'objet Error : [type: IgnisignError]

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

Énumérations associées :

• IGNISIGN_WEBHOOK_ACTION_SIGNATURE_IMAGE :

  • GENERATED : Déclenché lorsqu'une image de signature est générée

• 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 quelques avertissements)
  • ERROR : Le message est lié à une erreur (une action a échoué)