agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints
Create an inbound endpoint.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
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}/inbound-endpoints \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <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
Details
Returns the full URL to paste into the sending system, and the secret once. The URL carries one opaque key, not the board id — so it leaks no internal identifier into somebody else's logs, and rotating the secret does not change the URL. Tenancy comes off the endpoint row and never out of the POSTed body, which is what makes it unforgeable across tenants.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
signature_scheme | string<zinn, github> | No | zinn verifies X-Zinn-Signature over "<timestamp>.<body>"; github verifies GitHub's own X-Hub-Signature-256 over the body. One route, one rate limiter, one log, whichever… |
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 | — |
endpoint_key | string | Yes | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | No | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | Yes | — |
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 collapsing… |
has_secret | boolean | Yes | — |
request_count | integer | No | — |
rejected_count | integer | No | — |
last_rejection | string | No | Why the last refused request was refused — so "my n8n node says 404" is answerable from this screen rather than from a support ticket. |
last_seen_at | string | No | — |
created_at | string | No | — |
secret | string | Yes | Shown ONCE, here. |
Errors this endpoint can return
401 · 403 · 404 · 422