Skip to main content
Webhooks

Webhook Endpoint を更新する

Endpoint の受信 URL、説明、購読イベント、またはメタデータを更新します。

Webhook は現在 Beta 機能です。API、フィールド、および動作は今後のバージョンで変更される可能性があります。
PUT /api/v1/forward/webhook/endpoints/{endpoint_id} リクエストに含まれるフィールドのみ更新されます。省略したフィールドは現在の値を維持します。

リクエストヘッダー

Header必須説明
AuthorizationはいBearer <PAT または管理者 SAT>
Content-Typeはいapplication/json

パスパラメーター

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

リクエストボディのパラメーター

フィールド型必須説明
urlstringいいえ新しいイベント受信 URL。本番環境では HTTPS を推奨します。
descriptionstringいいえ新しい用途の説明。
eventsstring[]いいえ購読一覧全体を置き換えます。1 件以上必要です。* または具体的なイベント名を指定でき、前方一致ワイルドカードはサポートされません。完全なイベント名とトリガーはサポート対象の公開イベントを参照してください。
activebooleanいいえEndpoint が有効かどうか。有効化または無効化専用 API も使用できます。
metadataobjectいいえカスタムメタデータをマージ更新します。値は文字列で、null を渡すと該当キーを削除します。

リクエスト例

curl -s -X PUT 'https://api.qoder.com/api/v1/forward/webhook/endpoints/e149c233-1234-4abc-8def-1234567890ab' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Schedule completion notifications",
    "events": [
      "forward.schedule_run.succeeded",
      "forward.schedule_run.failed"
    ]
  }'

レスポンス例

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"
}
レスポンスフィールドは、Webhook Endpoint を取得するを参照してください。 Endpoint の更新では signing_secret は返されず、ローテーションもされません。

エラー

HTTPType発生条件
400invalid_request_errorURL、イベント一覧、メタデータ、またはリクエストボディが不正です。
401authentication_error認証情報がない、無効、または期限切れです。
403permission_error現在のトークンでは Webhook を管理できません。
404not_found_errorEndpoint が存在しないか、現在のアカウントから参照できません。
413invalid_request_errorリクエストボディが大きすぎます。
500/502/503api_errorサービスが一時的に利用できません。

関連

Webhook Endpoint を取得する

Webhook Endpoint を無効化する

はじめに
Agent の定義
Agent 環境の設定
Agent にタスクを委任する
Agent 連携
Agent コンテキストの管理
アカウント
ベストプラクティス
お知らせ
API リファレンス
Webhook Endpoint を更新する - Qoder