Steps to configure a webhook

Following are the steps to configure a webhook.

1. Webhook event selection:

Select the webhook event for which you want to receive the notification as given below.

"events": [ "CARD_STATUS_CHANGE" ]

2. Decide the endpoint:

Decide the endpoint where you want to receive the webhook notification.

Note that the endpoint should be hosted in your destination system.

"endpoint": "https://example.com"

3. Security configuration:

Determine the security characteristics as given below, choose the security credentials (username and password).

"config": { "basic_auth_username": "username", "basic_auth_password": "password", "custom_headers": [ { "header_name": "apikey", "header_value": "306e38e4-54be-469f-beca-4297129289d6" }

]

4. Create a webhook:

You can create a webhook now by sending a POST request to /webhooks endpoint as given below.

POST /webhooks

{ "endpoint": "https://example.com/", "events": [ "CARD_STATUS_CHANGE" ], "config": { "basic_auth_username": "username", "basic_auth_password": "password", "custom_headers": [ { "header_name": "apikey", "header_value": "306e38e4-54be-469f-beca-4297129289d6" } ], "created": "2021-05-27T18:48:00.074Z", "modified": "2021-05-27T18:48:00.074Z" } }

It is possible to link more than one event with a single endpoint.