The Webhook Object

Headers

PropertyTypeDescription
authStringTwo types of Authentication header:

- Basic: requires basic_username and basic_password. This header will be sent as Basic bas64(basic_username:basic_password)

- Secret-key: only requires the secret key string. This header will be sent as Bearer secret_key.
customStringOther constants headers that your endpoint requires.

Body

PropertyTypeDescription
uuidStringWebhook unique identifier (autogenerated).
nameStringWebhook name.
descriptionStringWebhook description.
eventStringEvent you want to suscribe to. To suscribe to all events send ‘ALL’ string.
urlStringWebhook endpoint URL.
is_activeBoolean​Webhook enabled or disabled.

Example

{
   "uuid": "ISGW-4-585a16b094d64ae99d019caf27795536",   
   "name": "webhook_1",
   "description": "My webhook #1",
   "event":"TRANSACTION_EVENT",
   "headers": {
       "auth": {
           "basic_username": "my_user",
           "basic_password": "my_pass",
           "secret_key": "my_secret_key"
       },
       "custom": {
           "header_key_1": "value_1",
           "header_key_2": "value_2"
       }
   },
   "url": "http://merchant-host.com/callback",
   "is_active": true
}