Webhooks

Create a webhook endpoint

Register an HTTPS endpoint for event deliveries. The response includes the signing secret ONCE — store it; later reads return a masked value.

post/v0/webhooks

Request

  • Base URL: https://api.schedulin.app
  • URL: https://api.schedulin.app/v0/webhooks
  • 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)

Request body

urlstring uri required
eventsstring[] required
descriptionstring

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.