BRIEF.

Outbound webhooks

BRIEF. can POST JSON from your device to URLs you save in the app (Tune → Webhooks). Nothing is sent automatically from our servers to your endpoint—you tap send on OUT or Log (or run a test from Settings). Use HTTPS in production.

Headers

Content-Type: application/json
X-Brief-Webhook-Schema: 2
Authorization: Bearer <secret> — only if you set a Bearer secret for that destination in the app

Body (schema version 2)

Top-level architect, assistant, and ghostwriter are stable for Zapier / Make field mapping. meta is a deterministic output snapshot (word counts, light tags). Branch automation on schemaVersion or X-Brief-Webhook-Schema if you ingested an older shape.

{
  "schemaVersion": 2,
  "architect": "string — Markdown brief",
  "assistant": "string — checkbox task surface",
  "ghostwriter": "string — sendable prose",
  "transcript": "string — raw transcript used for enrich",
  "meta": {
    "rawWordCount": 120,
    "wordCountBySlot": { "architect": 80, "assistant": 95, "ghostwriter": 110 },
    "combinedBriefWordCount": 285,
    "approxFillerHits": 6,
    "lexicalDiversity": 0.52,
    "repeatedWordHints": ["latency", "pilot"],
    "tags": ["Rich capture", "Briefs tightened"]
  },
  "metadata": {
    "sentAt": 1735689600000,
    "durationMs": 12000,
    "audioUri": "file:///… or null"
  }
}

Tips

Up to five named destinations; toggle “Manual POST” per destination for buttons on OUT / Log.
Treat the optional Bearer value as a shared secret—verify Authorization on your server or in Zapier filters.
Test POST in Settings is rate-limited per hour so iterating on automations does not hammer your URL.

Recipes

Zapier — Webhooks by Zapier → Catch Hook → map fields. Make — Custom webhook. n8n — Webhook node (POST). Your API — validate Bearer, parse JSON, store or forward.

Engineers: keep the canonical copy in the repo as docs/WEBHOOK_RECIPES.md when you change the payload shape (and bump BRIEF_WEBHOOK_SCHEMA_VERSION in the app).

← Home