agency-board
POST /v1/board-hooks/{endpointKey}
The public inbound door — n8n, Zapier, Make, GitHub.
Упълномощаване
Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/board-hooks/{endpointKey} \
-H "Content-Type: application/json" \
-d '{ }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
**Unauthenticated by design: the HMAC signature IS the authentication**, exactly as `/v1/webhooks/stripe` is. Send `X-Zinn-Signature: sha256=<hmac-sha256 over "<timestamp>.<raw body>">` and `X-Zinn-Timestamp` (unix seconds, within five minutes of now), signed with the endpoint's secret. The body must be a JSON object. Five top-level values — `event`, `status`, `title`, `body`, `ref` — are projected into the rule's condition surface as `payload_*`, so a rule can branch on them. Anything else in the body is stored in the request log and is not conditionable. ⛔ An unknown endpoint key and a bad signature both answer **404 with the same body**, deliberately: distinguishing them would turn this into an oracle for whether a key exists. The endpoint's OWNER sees the real reason on their own screen.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
endpointKey (path) | string | Да | The endpoint's opaque key — 32 hex characters. Deliberately not the board id: a board id in a URL customers paste into third-party systems leaks an internal identifier into some… |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
event | string | Не | — |
status | string | Не | — |
title | string | Не | — |
body | string | Не | — |
ref | string | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
accepted | boolean | Да | — |
rules_fired | integer | Не | — |
detail | string | Не | — |
Грешки, които този крайpoint може да върне
404 · 409 · 413 · 429