Profils de Signature Webhooks
Ce webhook est reçu lorsque des événements liés à un profil 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_PROFILE" |
action | IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILE | Oui | L'action associée à l'événement webhook |
msgNature | IGNISIGN_WEBHOOK_MESSAGE_NATURE | Oui | Le type de message |
content | IgnisignWebhookDto_SignatureProfile | 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 SDK 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
eterror
sont disponibles dans les callbacks.
L'objet Content : [type: IgnisignWebhookDto_SignatureProfile ]
champ | type | requis | description |
---|---|---|---|
signatureProfileId | string | Oui | L'identifiant du profil de signature lié à l'événement |
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 fournissant un contexte supplémentaire à l'erreur |
Énumérations Associées :
-
IGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILE
:CREATED
: Action déclenchée lorsqu'un profil de signature est crééARCHIVED
: Action déclenchée lorsqu'un profil de signature est archivé
-
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é)