briar
Open Briar
Open Briar
PUBLIC API

Bring external eventsinto Briar.

The public API docs explain how to deliver deployment, monitoring, and operational events from external services into a Briar channel.

Start with the guide you need

01

Get started

Follow the basic integration flow from creating a secret URL to sending your first JSON request.

View the integration guide 02

Incoming webhooks

Reference the webhook lifecycle, request schema, idempotency, limits, errors, and runnable curl example.

View the webhook reference

How to use these docs

  1. 01

    Prepare

    Create a webhook in a Briar channel and store the one-time secret URL safely.

  2. 02

    Implement

    Keep requests inside the JSON and size limits, then choose a stable idempotency key for each logical event.

  3. 03

    Operate

    Distinguish new, duplicate, and error responses, then rotate or revoke URLs as ownership and exposure change.