Endpoint にテストイベントを送信し、受信 URL と署名処理を確認します。
Webhook は現在 Beta 機能です。API、フィールド、および動作は今後のバージョンで変更される可能性があります。
POST /api/v1/forward/webhook/endpoints/{endpoint_id}/test
テストイベントのタイプは webhook.test で、Endpoint の購読一覧に追加する必要はありません。配信は非同期です。API の成功レスポンスはテストイベントが受理されたことを示し、受信側の処理完了を示すものではありません。
呼び出す前に Endpoint が有効であることを確認してください。無効な場合でも API が 202 を返すことがありますが、delivery_rows は 0 となりコールバックは送信されません。
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または管理者 SAT> |
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
endpoint_id | string | はい | Webhook Endpoint ID。 |
リクエスト例
レスポンス例
HTTP 202 Accepted
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
event_id | integer | このテストリクエストの識別子。 |
delivery_rows | integer | このテストで受理された配信タスク数。 |
エラー
| HTTP | Type | 発生条件 |
|---|---|---|
401 | authentication_error | 認証情報がない、無効、または期限切れです。 |
403 | permission_error | 現在のトークンでは Webhook を管理できません。 |
404 | not_found_error | Endpoint が存在しないか、現在のアカウントから参照できません。 |
500/502/503 | api_error | テストイベントを一時的に送信できません。 |

