Skip to content
DeepFrame Alpha
日本語
Webhooks

List webhook endpoints

GET/api/v1alpha1/webhooks

Returns the webhook endpoints registered in your workspace. Signing secrets are never included.

  • Access: an alpha-enabled API key with the MANAGE_WEBHOOKS permission.
  • Paging: limit defaults to 25, maximum 100. Pass next_cursor back unchanged as cursor.

Use an id from the list to read, update or delete an endpoint, or to look at its delivery history.

Authorization

apiKey
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor returned as next_cursor by the previous response. Pass it byte-for-byte as cursor; do not decode, edit, or construct it.

limit?number

Number of resources to return in one page. The default is 25 and the accepted range is 1-100.

Formatint32
Range1 <= value <= 100
Default25

Response 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 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"}

Search indexed videos POST

Searches your indexed videos with a natural-language query and returns ranked matches, each with a score and, where one exists, a media URL you can play back.

Create a webhook endpoint POST

Registers an endpoint of yours and subscribes it to video.indexed, video.failed and run.completed events.