Treat the URL as a credential
Anyone with the URL can post to the channel. Rotate it immediately if exposure is suspected.
Send your first event
The shortest path from issuing a secret URL in a channel to configuring an external service to send a JSON message.
1. Prepare a webhook
- 1
Open the destination channel
Open Incoming webhooks in the destination Briar channel. Organization owners and admins, plus the channel owner, can manage them.
- 2
Name and create it
Use a source-specific name such as “Deployment alerts” so the message author is recognizable in the channel.
- 3
Store the secret URL immediately
The full URL is shown only at that moment. Save it in a secret manager, never in source, issues, chat, or logs.
2. Build the request
Send a POST request to the issued URL. There is no separate Authorization header; the full URL is the credential.
- Method
POST- Endpoint
https://briar-api.wbai.workers.dev/hooks/channels/{webhook_id}/{secret}- Content-Type
application/json- Minimum body
{"text":"Production deployment completed."}
3. Common considerations
Design retry keys first
If an event can be retried, send Idempotency-Key and keep the same value for every attempt of the same logical event.
Handle both success states
A new message returns 201. An event already received returns 200 with duplicate: true. Treat both as success.
Stay within the limits
The body is at most 64KiB, text is 1–10,000 characters, blocks contains at most 50 items, and each webhook accepts up to 60 requests per 60 seconds.