Webhooks
Webhook endpointを更新
PATCH
/api/v1alpha1/webhooks/{webhook_id}Webhook endpointのURL、受信するevent、説明、有効・無効を変更します。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_WEBHOOKS権限。 - URLの条件: 新しいURLは作成時と同じ検査を受けます。HTTPSであること、credentialを含まないこと、publicなアドレスであること。
- 再試行:
Idempotency-KeyはPOSTのみが対象のため、PATCHの再送は重複排除されません。目的の状態が分かっている場合にのみ再送してください。
eventや有効・無効を変更した後は、配信履歴を確認して意図どおりの動作になったことを確かめてください。
認証
apiKey 認証Bearer <token>
場所: header
パスパラメーター
webhook_id*string
登録済みWebhook endpointの識別子です。
リクエストボディ
application/json
TypeScript 型定義
TypeScript では request body 型を使用します。
レスポンスボディ
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/api/v1alpha1/webhooks/wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "description": "Warehouse staging review pipeline", "enabled": true, "events": [ "video.failed", "run.completed" ], "url": "https://hooks.example.com/deepframe-v2" }'{ "created_at": "2026-08-08T10:00:00.000Z", "description": "Warehouse review pipeline", "enabled": true, "events": [ "video.indexed", "run.completed" ], "id": "wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "updated_at": "2026-08-08T10:09:00.000Z", "url": "https://hooks.example.com/deepframe"}