agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/test
Send a signed test delivery now.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/test \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The most useful button on the screen: an integrator wiring up n8n wants to see a request arrive before they build the rest of the workflow. Returns the delivery row, which carries the response status and the first 500 bytes the receiver answered with.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
boardId (path) | Uuid | はい | Project board ID (UUIDv7). |
webhookId (path) | Uuid | はい | Outbound webhook subscription ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
subscription_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
event | string | はい | — |
delivery_key | string | はい | Sent as `X-Zinn-Delivery`, so the receiver can dedupe too. |
payload | object | いいえ | The body exactly as it was signed and sent. |
status | BoardWebhookDeliveryStatus | はい | — |
attempts | integer | はい | — |
response_status | integer | いいえ | — |
response_snippet | string | いいえ | The first 500 bytes your endpoint answered with. When it answered but sent no body, the status we observed; when we could not reach it, or the fault was ours, authored copy sayi… |
next_attempt_at | string | いいえ | — |
delivered_at | string | いいえ | — |
replay_of_id | Uuid | いいえ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
created_at | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404