Webhooks

Register webhook

Register a new webhook endpoint. BriefGate will POST a signed JSON payload to the URL when the specified events occur. Supported events: item.submitted, intake.completed, client.viewed, chase.bounced, intake.stalled, intake.overdue, intake.archived. Set "format" to "slack" or "discord" to deliver a ready-made chat message to an incoming webhook of that service instead of the BriefGate envelope; the URL host is checked against the chosen format.

post/v1/webhooks

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[] required
format'raw' | 'slack' | 'discord'

Response

Webhook registered

idstring
urlstring uri
eventsstring[]
format'raw' | 'slack' | 'discord'
activeboolean
created_atstring date-time
secretstring

HMAC-SHA256 signing secret — returned only on creation.

Changes

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