Sign in

v1

latestOpenAPI 3.0.02026-07-175989869.3 KB
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"
}