Aller au contenu principal

Gestion de la Consommation des Webhooks

Ignisign fournit un mécanisme de webhook pour notifier votre backend des événements qui se produisent en lien avec votre application.

Configuration

Vous devez créer un endpoint de webhook dans la console IgniSign pour activer le mécanisme de webhook.

voir Intégrer IgniSign Avec Votre Backend pour plus de détails.

Vous pouvez utiliser les SDKs IgniSign pour gérer les événements de webhook ou vous pouvez implémenter le mécanisme de webhook par vous-même.

Gérer les événements de webhook avec les SDKs

Les SDKs bachen d'Ignisign 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.

Vous devez lier la méthode consumeWebhook du SDK à l'un des endpoints de votre application pour activer le mécanisme.

Lorsque vous recevez un événement de webhook, vous devez retourner une réponse 200 OK pour confirmer la réception de l'événement.

Gérer les événements de webhook sans SDKs

Si vous décidez de ne pas utiliser les SDKs IgniSign, vous pouvez implémenter le mécanisme de webhook par vous-même.

Si vous décidez d'implémenter le mécanisme de webhook par vous-même, vous devez suivre les étapes suivantes :

  • vérifier que le webhook provient d'IgniSign

    • appeler POST https://api.ignisign.io/v3/tokens/webhook-verification/checking-consumption avec le corps suivant :
    {
    "appId" : "your application id",
    "appEnv" : "your application environment",
    "verificationToken" : "the verification token provided in the webhook event"
    }
  • Vérifiez que le webhook est envoyé à la bonne application et environnement

  • Envoyez une réponse 200 OK pour confirmer la réception de l'événement.