Skip to navigation

Create Webhook Config

View as Markdown

Create a reusable webhook config for this workspace. The response includes the config’s signing secret — the only time it is ever returned, so store it securely. A workspace can hold at most 5 webhook configs (HTTP 429 beyond that).

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID

Request

This endpoint expects an object.
namestringRequired

Display name (1-50 characters; letters, digits, spaces, underscores, hyphens).

urlstringRequired

Webhook endpoint URL (HTTPS only, up to 2048 characters).

custom_headersmap from strings to strings or nullOptional
Up to 10 extra headers sent with every delivery.

Response

Successful Response
webhook_idstring
ID to reference this config from a campaign or deployment.
namestring
urlstring
created_bystring
created_atdatetime
updated_atdatetime
signing_secretstring
Secret used to sign deliveries. Returned only here, on create. Store it immediately.
custom_headersmap from strings to strings or nullOptional
updated_bystring or nullOptional

Errors

422
Unprocessable Entity Error
429
Too Many Requests Error