Webhooks

A webhook endpoint receives signed HTTP POSTs for the event types it subscribes to. Register one with url (HTTPS only), events, and optionally description and enabled. The register response includes the signing_secret exactly once; store it immediately, because it cannot be shown again. The list and single-endpoint reads return id, url, events, enabled, description, and created_at.

For event types, the payload envelope, signature verification, and retries, see Console webhooks.

curl -X GET "https://api.surfacedby.com/api/v1/console/webhooks" \
  -H "X-API-Key: string"

null

curl -X POST "https://api.surfacedby.com/api/v1/console/webhooks" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

null

curl -X GET "https://api.surfacedby.com/api/v1/console/webhooks/string" \
  -H "X-API-Key: string"

null

curl -X DELETE "https://api.surfacedby.com/api/v1/console/webhooks/string" \
  -H "X-API-Key: string"

null