Create webhook

Create a new webhook configuration, and start streaming events. We strongly encourage using batching, where we will send a batch of events whenever the number of events hits macBatchSize or events have been waitng for the batchTimeout in seconds, whichever occurs first will trigger the next batch to be sent.

Note: Use the batching options, and only subscribe to the event types you require to maximise efficency

Body Params

Detail of the webhook configuration to create

string
required

The name of the webhook configuration

string
required

The target url of the webhook

string

The secret used to create HMAC secure hash

subscriptions
array of objects

Events for webhook

subscriptions
boolean

Whether to use event batching, or send single events

number
1 to 500

Maximum number of events to batch before it is sent

number
1 to 60

Maximum duration in seconds to wait before a batch is sent

Headers
string

An optional ETag for optimistic concurrency control

Responses

404

The webhook configuration was not found

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json