List all webhooks - api.video

Requests to this endpoint return a list of your webhooks (with all their details). You can filter what the webhook list that the API returns using the parameters described below.

{ "data": [ { "createdAt": "2021-01-08T14:12:18.000Z", "events": [ "video.encoding.quality.completed" ], "url": "http://clientnotificationserver.com/notif?myquery=query", "webhookId": "webhook_XXXXXXXXXXXXXXX" }, { "createdAt": "2021-01-12T12:12:12.000Z", "events": [ "video.encoding.quality.completed" ], "url": "http://clientnotificationserver.com/notif?myquery=query2", "webhookId": "webhook_XXXXXXXXXYYYYYY" } ], "pagination": { "currentPage": 1, "currentPageItems": 11, "itemsTotal": 11, "links": [ { "rel": "self", "uri": "https://ws.api.video/webhooks?currentPage=1" }, { "rel": "first", "uri": "https://ws.api.video/webhooks?currentPage=1" }, { "rel": "last", "uri": "https://ws.api.video/webhooks?currentPage=1" } ], "pageSize": 25, "pagesTotal": 1 } }

Request

Query Params

events

string

optional

The webhook event that you wish to filter on.

Example:

video.encoding.quality.completed

currentPage

integer

optional

Choose the number of search results to return per page. Minimum value: 1

Example:

pageSize

integer

optional

Results per page. Allowed values 1-100, default is 25.

Example:

Responses

🟢200Success

application/json

Body

data

array[object (Webhook) {4}]

optional

createdAt

string <date-time>

optional

When an webhook was created, presented in ISO-8601 format.

Example:

2019-06-24T11:45:01.109Z

events

array[string]

optional

A list of events that will trigger the webhook.

Example:

["video.encoding.quality.completed"]

url

string

optional

URL of the webhook

Example:

http://clientnotificationserver.com/notif?myquery=query

webhookId

string

optional

Unique identifier of the webhook

Example:

webhook_XXXXXXXXXXXXXXX

pagination

object (Pagination)

optional

Example:

{"currentPage":3,"currentPageItems":20,"itemsTotal":123,"links":{"first":{"rel":"first","uri":"/videos/search?currentPage=1&pageSize=20"},"last":{"rel":"last","uri":"/videos/search?currentPage=6&pageSize=20"},"next":{"rel":"next","uri":"/videos/search?currentPage=4&pageSize=20"},"previous":{"rel":"previous","uri":"/videos/search?currentPage=2&pageSize=20"}},"pageSize":20,"pagesTotal":7}

currentPage

integer

read-onlyoptional

The current page index.

currentPageItems

integer

read-onlyoptional

The number of items on the current page.

itemsTotal

integer

read-onlyoptional

Total number of items that exist.

links

array[object (PaginationLink) {2}]

required

pageSize

integer

read-onlyoptional

Maximum number of item per page.

pagesTotal

integer

read-onlyoptional

Number of items listed in the current page.