Webhooks liés à la demande de signature

Ce webhook est reçu lorsqu'un événement lié à une demande de signature est déclenché.

attention

Si vous créez une demande de signature avec un profil de signature qui est en mode d'intégration EMBEDDED,
vous DEVEZ enregistrer un callback pour l'action LAUNCHED.
C'est ainsi que vous recevrez le jeton qui vous permettra d'initialiser la Session de Signature dans votre application.

info

Les actions CANCELLED et EXPIRED sont uniquement utilisées pour les cas où personne n'a signé.
Si au moins une personne a signé et que la demande de signature expire ou est annulée, l'état COMPLETED est envoyé.

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_REQUEST"
action	IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST	Oui	L'action associée à l'événement webhook
msgNature	IGNISIGN_WEBHOOK_MESSAGE_NATURE	Oui	Le type de message
content	IgnisignWebhookDto_SignatureRequest	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é.
• 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_SignatureRequest]

champ	type	requis	description
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
status	IGNISIGN_SIGNATURE_REQUEST_STATUS	Non	Le statut de la demande de signature
signers	Liste de IgnisignWebhookDto_SignatureRequestSigner	Non	Une liste des signataires liés à la demande de signature. Fournie uniquement si le profil de signature associé à la demande de signature est configuré en mode intégré

IgnisignWebhookDto_SignatureRequestSigner

champ	type	requis	description
signerId	string	Oui	L'id du signataire associé à la signature
signerExternalId	string	Oui	Une référence externe (votre référence) si vous l'avez fournie lors de la création du signataire
token	string	Oui	Le jeton qui peut être utilisé pour initialiser la session de signature dans votre application

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 qui fournissent un contexte supplémentaire à l'erreur

Énumérations associées :

• IGNISIGN_WEBHOOK_ACTION_SIGNATURE_REQUEST :

  • INITIALIZED : Déclenché lorsqu'une demande de signature est créée
  • UPDATED : Déclenché lorsqu'une demande de signature est mise à jour
  • READY : Déclenché lorsqu'une demande de signature est prête à être signée
  • WAITING_DOCUMENTS : Déclenché lorsqu'une demande de signature attend des documents (demande de document)
  • LAUNCHED : Déclenché lorsqu'une demande de signature est lancée
  • CANCELLED : Déclenché lorsqu'une demande de signature est annulée
  • EXPIRED : Déclenché lorsqu'une demande de signature a expiré
  • COMPLETED : Déclenché lorsqu'une demande de signature est complétée (finalisé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 complétée)
  • WARNING : Le message est lié à un avertissement (une action est complétée mais avec quelques avertissements)
  • ERROR : Le message est lié à une erreur (une action a échoué)