agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints
Create an inbound endpoint.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
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> }'已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
boardId (path) | Uuid | 是 | Project board ID (UUIDv7). |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | — |
signature_scheme | string<zinn, github> | 否 | `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> | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | 是 | — |
endpoint_key | string | 是 | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | 否 | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | 是 | — |
status | BoardAutomationStatus | 是 | `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 | 是 | — |
request_count | integer | 否 | — |
rejected_count | integer | 否 | — |
last_rejection | string | 否 | 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 | 否 | — |
created_at | string | 否 | — |
secret | string | 是 | Shown ONCE, here. |
此端点可能返回的错误
401 · 403 · 404 · 422