Skip to main content
​
name
String!
required
The name of the webhook (max 128 characters).
​
callbackUrl
String!
required
The url to which the webhook message should be sent.
​
securityToken
String!
required
A string value to hash along with deduplicationId using SHA-256. Included in the webhook message for added security.
​
bucketId
String
An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
​
bucketSortkey
String
An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
​
deduplicate
Boolean
If enabled, new webhooks won’t be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
​
groupId
String
A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
This field is deprecated. GroupId is deprecated and will be removed in the future. Messages will be grouped by webhookId