Skip to navigation

Update webhook config

View as Markdown
Update a webhook config's name, URL, or custom headers. The signing secret never changes. Campaigns and deployments referencing the config by id immediately deliver to the updated URL.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
webhook_idstringRequired
ID of the webhook config

Request

This endpoint expects an object.
namestring or nullOptional

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

urlstring or nullOptional

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

custom_headersmap from strings to strings or nullOptional

New custom headers (up to 10). Sending null clears them; omit to keep the current value.

Response

Successful Response
webhook_idstring
ID to reference this config from a campaign or deployment.
namestring
urlstring
created_bystring
created_atdatetime
updated_atdatetime
custom_headersmap from strings to strings or nullOptional
updated_bystring or nullOptional

Errors

404
Not Found Error
422
Unprocessable Entity Error