alerts-api---webhooks

Set webhook URL

Sets (or replaces) the delivery URL for all your alert feeds.

Before saving, a GET request is sent to the URL — your server must respond with HTTP 200, otherwise this endpoint returns 400.

Alert deliveries themselves arrive as POST requests with a JSON array body.

The URL is stored per user: changing it here instantly affects every feed, including alerts already queued for delivery. Feeds cannot be created until the webhook is configured.

A signing secret is provisioned on the first call and returned in secret once; later calls return secret: null. Lost it? Use POST /webhooks/rotate-secret.

put/alerts-api/webhooks

Request

  • Base URL: https://api.casafari.com
  • URL: https://api.casafari.com/alerts-api/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Response

Successful Response

urlstring required
secretstring nullable required

Changes

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