Webhooks

Retrieve Webhook details

Retrieve webhook details by id.

get/webhooks/{webhookId}

Path parameters

webhookIdstring required

The unique webhook you wish to retreive details on.

Response

Success

webhookIdstring

A unique identifier of the webhook you subscribed to.

createdAtstring date-time

The time and date when you created this webhook subscription, in ATOM UTC format.

eventsstring[]

A list of events that you subscribed to. When these events occur, the API triggers a webhook call to the URL you provided.

urlstring

The URL where the API sends the webhook.

signatureSecretstring

A secret key for the webhook you subscribed to. You can use it to verify the origin of the webhook call that you receive.

Example response

{
  "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