agency-board
POST /v1/board-hooks/{endpointKey}
The public inbound door — n8n, Zapier, Make, GitHub.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/board-hooks/{endpointKey} \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 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… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
event | string | いいえ | — |
status | string | いいえ | — |
title | string | いいえ | — |
body | string | いいえ | — |
ref | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
accepted | boolean | はい | — |
rules_fired | integer | いいえ | — |
detail | string | いいえ | — |
このエンドポイントが返すエラー
404 · 409 · 413 · 429