Webhooks — Pro API key

Register an https URL for signed incident events (Pro).

We POST a signed challenge first; your URL must echo it (JSON {"challenge": ...} or the plain value) before deliveries start. The signing secret is returned once. Omit providers or events for all. Up to 5 per API key. See /llms.txt → Webhooks.

post/api/webhooks

Request

  • Base URL: https://outage.me
  • URL: https://outage.me/api/webhooks
  • Auth: API key in header x-tarantula-api-key

Request body

urlstring required

https, public hostname.

providersstring[]
eventsstring[]

Response

Registered and verified (201) or pending verification (202)

webhook_idstring required
urlstring
providersunknown
eventsstring[]
status'pending_verification' | 'active' | 'disabled' required
failuresinteger
disabled_reasonstring nullable
key_idstring
created_atinteger nullable
last_delivery_atinteger nullable
last_resultstring nullable
secretstring required
verificationstring

Changes

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