频道接收 Webhook

生命周期

1. CREATE

   Create

   In Incoming webhooks for the destination channel, enter a source-specific name. Organization owners and admins, plus the channel owner, can manage webhooks. Archived channels cannot create them.

2. STORE

   Store

   The complete secret URL is shown once after creation or rotation. Store it in a secret manager and disclose it only to the sending system.

3. ROTATE

   Rotate

   Rotate after exposure or a sender ownership change. The old URL returns 404 immediately, so update the sender with the new URL and send a test request right away.

4. REVOKE

   Revoke

   Revoke a webhook when it is no longer used. Revocation is immediate and irreversible; create a new webhook if the integration is needed again.

端点

Use the exact URL shown after creation. You do not need to assemble webhook_id and secret yourself or add an Authorization header.

POST https://briar-api.wbai.workers.dev/hooks/channels/{webhook_id}/{secret}

JSON 模式

The body must be application/json and include at least one of text or blocks. No properties beyond those below are accepted.

可选标头

Idempotency-Key is also 1–200 characters after trimming. Use it instead of eventId, or send both with exactly the same value.

可执行的 curl 示例

Replace the entire example URL on the first line with the one-time secret URL from Briar, then run the command.

export BRIAR_WEBHOOK_URL='https://briar-api.wbai.workers.dev/hooks/channels/{webhook_id}/{secret}'

curl --fail-with-body \
  --request POST \
  --url "$BRIAR_WEBHOOK_URL" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: deploy-2026-08-12-001' \
  --data '{
    "text": "Production deployment completed.",
    "blocks": [
      {"type":"header","text":{"type":"plain_text","text":"Deployment complete"}},
      {"type":"section","text":{"type":"mrkdwn","text":"`v42` is live in *production*."}},
      {"type":"divider"},
      {"type":"markdown","text":"- [x] Health checks\n- [ ] Monitor metrics"}
    ]
  }'

新消息响应 · 201 Created

{
  "message": {
    "id": "…",
    "body": "Production deployment completed.",
    "blocks": [
      { "type": "header", "text": { "type": "plain_text", "text": "Deployment complete" } },
      { "type": "section", "text": { "type": "mrkdwn", "text": "`v42` is live in *production*." } },
      { "type": "divider" },
      { "type": "markdown", "text": "- [x] Health checks\n- [ ] Monitor metrics" }
    ],
    "author": {
      "type": "webhook",
      "id": "…",
      "name": "Deploy alerts"
    }
  },
  "duplicate": false
}

幂等性与安全重试

• Use a value that remains stable in the sending system, such as a deployment ID or monitoring event ID.
• Repeating the same key on the same webhook does not create another message. Briar returns the original message with 200 OK and duplicate: true.
• If duplicate requests contain different text or blocks, the first message stays unchanged. Send the same content and key for every attempt of one logical event.
• Without a key, every request creates a message. Use a key for integrations that can retry after a network failure.

限制

Request method

POST only

Body format

application/json

Body size

65,536 bytes (64KiB) maximum

Message content

text: 1–10,000 characters; blocks: 1–50; markdown blocks: 12,000 characters total

Idempotency key

eventId or Idempotency-Key: 1–200 characters

Request rate

Up to 60 requests per webhook per 60 seconds

After the secret URL and Content-Type checks pass, a request counts toward the rate limit even when its JSON or fields are invalid.

错误与恢复