Webhooks Consumption Management

Ignisign provides a webhook mechanism to notify your backend of events that occur associated to your application.

Configuration

You need to create a webhook endpoint in IgniSign Console to enable the webhook mechanism.

see Integrate IgniSign With Your Backend for more details.

You can use the IgniSign SDKs to handle webhook events or you can implement the webhook mechanism by yourself.

Handle webhook events with SDKs

Ignisign bachen SDKs provide a callback registration mecanism of typed events.

When you use the SDks:

• The verificationToken is automatically verified.
• The appId and appEnv are automatically checked.
• Only topic, action, msgNature, content and error are available in the callbacks.

You have to bind the consumeWebhook method of the SDK to one of your application endpoint to enable the mechanism.

When you receive a webhook event, you must return a 200 OK response to confirm the reception of the event.

Handle webhhok events without SDKs

If you decide to not use the IgniSign SDKs, you can implement the webhook mechanism by yourself.

if you decide to implement the webhook mechanism by yourself, you have to implement the following steps:

• verify that the webhook comes from IgniSign

  • call POST https://api.ignisign.io/v3/tokens/webhook-verification/checking-consumption with the following body:

  {
     "appId"             : "your application id",
     "appEnv"            : "your application environment",
     "verificationToken" : "the verification token provided in the webhook event"
  }

• Verify that the webhook is sent to the right application and environment

• Send back a 200 OK response to confirm the reception of the event.