agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/test
Send a signed test delivery now.
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 POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/test \
-H "Authorization: Bearer zdk_live_…"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
Details
The most useful button on the screen: an integrator wiring up n8n wants to see a request arrive before they build the rest of the workflow. Returns the delivery row, which carries the response status and the first 500 bytes the receiver answered with.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
webhookId (path) | Uuid | Yes | Outbound webhook subscription ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event | string | Yes | — |
delivery_key | string | Yes | Sent as `X-Zinn-Delivery`, so the receiver can dedupe too. |
payload | object | No | The body exactly as it was signed and sent. |
status | BoardWebhookDeliveryStatus | Yes | — |
attempts | integer | Yes | — |
response_status | integer | No | — |
response_snippet | string | No | The first 500 bytes your endpoint answered with. When it answered but sent no body, the status we observed; when we could not reach it, or the fault was ours, authored copy sayi… |
next_attempt_at | string | No | — |
delivered_at | string | No | — |
replay_of_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404