Webhooks

Update a webhook endpoint

Update URL, subscribed events, description, or enabled state. Re-enabling resets the failure streak.

patch/v0/webhooks/{id}

Request

  • Base URL: https://api.schedulin.app
  • URL: https://api.schedulin.app/v0/webhooks/{id}
  • Auth: one of:
    • API key in header x-api-key
    • OAuth 2 (authorization code, authorization URL https://api.schedulin.app/oauth/authorize, token URL https://api.schedulin.app/oauth/token, scopes: webhooks:write)

Path parameters

idstring required

Request body

urlstring uri
eventsstring[]
descriptionstring nullable
enabledboolean

Response

OK

idstring required
urlstring required
secretstring required
eventsstring[] required
descriptionstring nullable required
enabledboolean required
consecutiveFailuresinteger required
lastSuccessAtstring date-time nullable required
lastFailureAtstring date-time nullable required
disabledAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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