🔐 Bundle plugin only: This is exclusive to the Video, Audio & Live Bundle. Get the bundle plugin here.

Fields

FieldTypeDescription
uuidTextThe webhook server endpoint that was provided.
urlTextThe webhook server endpoint that was provided.
Basic authTextThe basic auth credentials that will be used to POST to the webhook URL.
Retry typeTextThe retry configuration for this webhook. Options: "circuit-breaker", "exponential".
Event TypesTextA comma-separated list of event types the webhook is subscribed to, with each event wrapped in quotes (e.g., "meeting.started", "meeting.ended")

Returned Values

FieldTypeDescription
uuidTextThe unique identifier for this webhook.
urlTextThe webhook server endpoint that was provided.
hmacTextA secret that can be used to verify the signature of the webhook.
basicAuthTextThe basic auth credentials that will be used to POST to the webhook URL.
retryTypeTextThe retry configuration for this webhook endpoint.
eventTypesArrayThe set of event types this webhook is subscribed to.
stateTextThe current state of the webhook. Options: "FAILED", "INACTIVE".
failedCountNumberThe number of consecutive failures this webhook has made.
lastMomentPushedTextThe ISO 8601 time of the last moment an event was pushed to the webhook server.
domainIdTextThe domain ID this webhook is associated with.
createdAtTextThe ISO 8601 time of when this webhook was created.
updatedAtTextThe ISO 8601 time of when this webhook was last updated.
error.status_codeNumberThe HTTP status code returned by the API (e.g., 200 for success).
error.status_messageTextThe HTTP status message returned by the API (e.g., "OK").
error.bodyTextThe raw error body message as a string.
returned_an_errorBooleanA flag indicating whether the API returned an error. false means no error occurred.