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.
alertRecurrence
The recurrence of the webhook. Can be INDEFINITE or ONCE.
The conditions which must be met in order for the webhook to send a message.
retrySettings
The settings for retrying failed webhook messages.
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).
publishingType
The type of publishing for the webhook. If not set, it defaults to SINGLE.
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.