Demande de Documents Webhooks

Ce webhook est reçu lorsque des événements liés à une demande de document 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 : "DOCUMENT_REQUEST"
action	IGNISIGN_WEBHOOK_ACTION_DOCUMENT_REQUEST	Oui	L'action associée à l'événement webhook
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Oui	Le type de message
content	IgnisignWebhookDto_DocumentRequest	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_DocumentRequest ]

champ	type	requis	description
signatureRequestId	string	Oui	L'id de la demande de signature associée à la demande de document
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 demande de document
documentExternalId	string	Non	Une référence externe (votre référence) si vous l'avez fournie lors de la création du document
documentNature	string	Oui	Le type de document
mimeType	string	Oui	Le type MIME du document fourni

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_DOCUMENT_REQUEST :

  • PROVIDED : Déclenché lorsqu'un document est fourni à une demande de document

• 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é)