Webhook Endpoint を取得する

Webhook は現在 Beta 機能です。API、フィールド、および動作は今後のバージョンで変更される可能性があります。

GET /api/v1/forward/webhook/endpoints/{endpoint_id}

リクエストヘッダー

Header	必須	説明
`Authorization`	はい	`Bearer <PAT または管理者 SAT>`

パスパラメーター

パラメーター	型	必須	説明
`endpoint_id`	string	はい	Webhook Endpoint ID。

リクエスト例

curl -s 'https://api.qoder.com/api/v1/forward/webhook/endpoints/e149c233-1234-4abc-8def-1234567890ab' \
  -H "Authorization: Bearer $QODER_PAT"

レスポンス例

HTTP 200 OK

{
  "id": "e149c233-1234-4abc-8def-1234567890ab",
  "url": "https://example.com/webhooks/qoder",
  "description": "Schedule notifications",
  "events": [
    "forward.schedule.created",
    "forward.schedule_run.succeeded",
    "forward.schedule_run.failed"
  ],
  "metadata": {
    "environment": "production"
  },
  "active": true,
  "last_success_at": "2026-09-01T09:07:59Z",
  "last_failure_at": null,
  "consecutive_fail": 0,
  "created_at": "2026-09-01T08:00:00Z",
  "updated_at": "2026-09-01T09:07:59Z"
}

レスポンスフィールド

フィールド	型	説明
`id`	string	Endpoint ID。
`url`	string	イベント受信 URL。
`description`	string	Endpoint の説明。未設定の場合は省略されることがあります。
`events`	string[]	現在の購読イベント。
`metadata`	object	Endpoint のメタデータ。
`active`	boolean	Endpoint がイベントを受信するかどうか。
`last_success_at`	string/null	直近の配信成功日時。RFC 3339 形式。
`last_failure_at`	string/null	直近の配信失敗日時。RFC 3339 形式。
`disabled_reason`	string	Endpoint が無効になった理由。理由がない場合は省略されます。
`consecutive_fail`	integer	連続配信失敗回数。
`created_at`	string	作成日時。RFC 3339 形式。
`updated_at`	string	更新日時。RFC 3339 形式。

この Endpoint では signing_secret は返されません。

エラー

HTTP	Type	発生条件
`401`	`authentication_error`	認証情報がない、無効、または期限切れです。
`403`	`permission_error`	現在のトークンでは Webhook を管理できません。
`404`	`not_found_error`	Endpoint が存在しないか、現在のアカウントから参照できません。
`500/502/503`	`api_error`	サービスが一時的に利用できません。

Webhook Endpoint を取得する

リクエストヘッダー

パスパラメーター

リクエスト例

レスポンス例

レスポンスフィールド

エラー

関連

Webhook Endpoint を更新する

テストイベントを送信する

​リクエストヘッダー

​パスパラメーター

​リクエスト例

​レスポンス例

​レスポンスフィールド

​エラー

​関連

Webhook Endpoint を更新する

テストイベントを送信する

リクエストヘッダー

パスパラメーター

リクエスト例

レスポンス例

レスポンスフィールド

エラー

関連