Sign in

v1

latestOpenAPI 3.0.02026-07-175989869.3 KB
Webhooks

List all webhooks

Retrieve a list of all webhooks configured for the current workspace.

get/webhooks

Query parameters

eventsstring

The webhook event that you wish to filter on.

currentPageinteger

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

pageSizeinteger

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

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "createdAt": "2019-06-24T11:45:01Z",
      "webhookId": "webhook_XXXXXXXXXXXXXXX",
      "events": "[\"video.encoding.quality.completed\"]",
      "url": "http://clientnotificationserver.com/notif?myquery=query",
      "signatureSecret": "signatureSecret"
    },
    {
      "createdAt": "2019-06-24T11:45:01Z",
      "webhookId": "webhook_XXXXXXXXXXXXXXX",
      "events": "[\"video.encoding.quality.completed\"]",
      "url": "http://clientnotificationserver.com/notif?myquery=query",
      "signatureSecret": "signatureSecret"
    }
  ]
}