Webhooks

Update webhook

put/api/webhooks/{id}

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/webhooks/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

Request body

urlstring uri
descriptionstring
eventsstring[]
status'active' | 'disabled'

Response

Updated webhook

idstring required
urlstring required
descriptionstring
eventsstring[] required
status'active' | 'disabled' required
secretstring

Returned by creation and single-webhook lookup; omitted from list/update responses.

consecutiveFailuresinteger
lastSuccessAtstring nullable
lastFailureAtstring nullable
lastFailureReasonstring nullable
createdAtstring
updatedAtstring

Changes

No recorded changes to this operation across all 1 revision of this API.