Aller au contenu principal

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é.

champtyperequisdescription
topicStringOuiValeur fixe : "SIGNATURE_PROFILE"
actionIGNISIGN_WEBHOOK_ACTION_SIGNATURE_PROFILEOuiL'action associée à l'événement webhook
msgNatureIGNISIGN_WEBHOOK_MESSAGE_NATUREOuiLe type de message
contentIgnisignWebhookDto_SignatureProfileNonLe contenu du webhook
errorIgnisignErrorNonL'erreur éventuelle
appIdstringOuiL'appId associé à l'événement
appEnvIGNISIGN_APPLICATION_ENVOuiL'appEnv associé à l'événement
verificationTokenstringOuiUn 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 et error sont disponibles dans les callbacks.

L'objet Content : [type: IgnisignWebhookDto_SignatureProfile ]

champtyperequisdescription
signatureProfileIdstringOuiL'identifiant du profil de signature lié à l'événement

L'objet Error : [type: IgnisignError]

champtyperequisdescription
errorCodeIGNISIGN_ERROR_CODESouiLe code d'erreur
messagestringnonUn message lisible par l'homme décrivant l'erreur
contextobject (any)nonUne 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é)