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

Changes

Changed in 4 of the 50 revisions of this API.413

Oct 2, 2024ebf0925369031See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f8849See the full diff
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the live-stream.broadcast.ended enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the live-stream.broadcast.started enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the video.caption.generated enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the video.encoding.quality.completed enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the video.source.recorded enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the video.summary.generated enum value from the /// response property for the response status
  response-property-enum-value-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history