agency-board

PATCH `/v1/agency/boards/{boardId}/webhooks/{webhookId}`

Change a webhook, or pause and resume it.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "url": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Parameters

Name	Type	Required	What it is
`boardId (path)`	`Uuid`	Yes	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Yes	Outbound webhook subscription ID (UUIDv7).

Request body

Name	Type	Required	What it is
`name`	`string`	Yes	—
`url`	`string`	Yes	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	No	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	No	—

Response

Name	Type	Required	What it is
`id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Yes	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Yes	—
`url`	`string`	Yes	—
`events`	`string[]`	No	—
`status`	`BoardAutomationStatus`	Yes	`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
`has_secret`	`boolean`	Yes	Whether a signing secret is stored. The secret itself is in Vault and is returned only by create and rotate; no endpoint can read it back.
`consecutive_failures`	`integer`	No	—
`suspended_reason`	`string`	No	Why we paused this webhook, in authored copy from a closed table — never an exception from our own code. It distinguishes your endpoint refusing a delivery, your endpoint being…
`suspended_at`	`string`	No	—
`last_delivered_at`	`string`	No	—
`last_failed_at`	`string`	No	—
`created_at`	`string`	No	—

Errors this endpoint can return

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}