Webhooks

Register a webhook endpoint

Returns the signing secret exactly once. Every delivery is signed with HMAC-SHA256 over the timestamp, a period, and the raw request body; verify it and reject stale timestamps. The URL is validated at registration and the connection pinned at delivery, so an endpoint pointing at a private address is refused. Works with an API key holding webhooks:write, so a deploy script can register its own endpoint; every change is audited.

post/v1/webhook-endpoints

Request

  • Base URL: https://www.chatrail.dev
  • URL: https://www.chatrail.dev/v1/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • API key in cookie chatrail_session

Request body

urlstring uri required
descriptionstring
eventsstring[] required
connectionstring

Response

Created, with the one-time signing secret.

Changes

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