Create Webhook configuration

Webhook provides the mechanism to push tracking events as they occur. With help of this user would be able to receive events as they are generated and is received to the end user. This operation creates a webhook configuration. It needs details of events for which webhook tracking is required also the URL with its authorization details to which the tracking events be pushed.

SecuritybearerAuth
Request
Request Body schema: application/json
name
required
string

It indicates the desired name of the webhook
Max length = 50.

type
required
string

It indicates the type of webhook. Currently it takes tracking as value.

events
required
Array of strings
url
required
string

It indicates the customer url to which events should be sent.

timeOut
number

It indicates the timeout value before system waits response from the customer url, here timeout indicates in seconds.

status
string

It indicates the status of the webhook. By default it takes active. To mark it inactive use in-active

required
custom (object) or basic (object)
Responses
200

Webhook created successfully

401

The request could not be authorized.

post/api/v1/webhookConfig
Request samples
application/json
{
  • "name": "webhook1",
  • "type": "tracking",
  • "events": [
    ],
  • "url": "https://webhook.com",
  • "timeOut": 5,
  • "status": "active",
  • "authParams": {
    }
}
Response samples
application/json
{
  • "webHookConfigID": "1Q86AvxyqmA",
  • "name": "webhook1",
  • "type": "tracking",
  • "events": [
    ],
  • "url": "https://webhook.com",
  • "timeOut": 5,
  • "status": "active",
  • "authParams": {
    }
}