agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints
Create an inbound endpoint.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
boardId (path) | Uuid | Igen | Project board ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
name | string | Igen | — |
signature_scheme | string<zinn, github> | Nem | `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> | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Igen | — |
endpoint_key | string | Igen | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | Nem | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | Igen | — |
status | BoardAutomationStatus | Igen | `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 | Igen | — |
request_count | integer | Nem | — |
rejected_count | integer | Nem | — |
last_rejection | string | Nem | 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 | Nem | — |
created_at | string | Nem | — |
secret | string | Igen | Shown ONCE, here. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422