コンテンツへスキップ
Webhooks

Webhook endpointを一覧表示

GET/api/v1alpha1/webhooks

ワークスペースに登録されているWebhook endpointを返します。signing secretは含まれません。

  • アクセス: alphaを有効にしたAPI keyとMANAGE_WEBHOOKS権限。
  • ページング: limitの既定値は25、最大は100。next_cursorをそのままcursorとして渡します。

一覧のidを使って、endpointの取得、更新、削除、または配信履歴の確認ができます。

認証

apiKey
認証Bearer <token>

場所: header

クエリパラメーター

cursor?string

前の応答のnext_cursorとして返されたopaqueなcursorです。decode、編集、組み立てをせず、そのままcursorとして渡してください。

limit?number

1ページで返すresource数です。既定値は25で、1から100まで指定できます。

形式int32
範囲1 <= value <= 100
デフォルト25

レスポンスボディ

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 GET "https://example.com/api/v1alpha1/webhooks" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
{  "data": [    {      "created_at": "2026-08-08T10:00:00.000Z",      "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"    }  ],  "has_more": false,  "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}