API Reference

Create a new webhook subscription

post
https://datahub-subscription.api.eu1.dev.scalar.zf.com/v1/webhooks

Creates a new webhook subscription. A webhook test is performed against the provided endpoint before persistence. If the test fails, the subscription is not created (422). Duplicate names within the same organization result in a 409 Conflict.

Body Params
string
required
length between 3 and 250

Unique name for the webhook subscription within the organization

uri
required
^https://

The HTTPS endpoint URL that will receive webhook events. Must be a valid HTTPS URL.

int32
required
1 to 500
Defaults to 500

Maximum number of events to include in a single webhook delivery batch

int32
required
0 to 300000
Defaults to 0

Maximum time (in milliseconds) to wait before sending a batch, even if batch size is not reached. 0 means immediate delivery.

subscriptionEventGroups
array of objects
required
length ≥ 1

Event groups and specific events to subscribe to

subscriptionEventGroups*
string
required

Name of the event group to subscribe to

int32
required

Version of the event group

eventNames
array of strings
required
length ≥ 1

Specific event names within the group to subscribe to

eventNames*
boolean
Defaults to true

Whether overflow mode (S3 fallback) is enabled for large payloads

customHeaders
array of objects
length ≤ 5

Custom HTTP headers to include in webhook deliveries. Maximum 5, no duplicate keys allowed.

customHeaders
Responses

Updated about 20 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 20 hours ago

Did this page help you?