# BackstagePass API and webhooks

> An HTTP API and signed outbound webhooks for one BackstagePass creator's own account. Base URL https://backstagepass.com. Auth header: Authorization: Bearer <api-key>.

The API reads your account, and its People calls add, find, revoke, block and unblock one person on your list, keyed by email. Someone added is Invited: no account, no follow and no email from you until they sign in, except the welcome letter when welcome is true. Webhooks are added by a person in Studio, not by API. An agent needs a human for two things: the API key, and adding the webhook URL.

## Docs

- [Full reference as markdown](https://backstagepass.com/developers/llms-full.txt): everything below in one plain-text file
- [Integrate as an agent](https://backstagepass.com/help/how/automations#agent-steps): numbered steps with the exact request, the expected response, and what to do on 401, 429 and a bad signature
- [Developer quickstart](https://backstagepass.com/help/how/automations#quickstart): prove the key, prove a signed webhook lands

## Machine-readable

- [OpenAPI 3.1](https://backstagepass.com/developers/openapi.json): every endpoint, request bodies, responses and errors
- [Webhook JSON Schema](https://backstagepass.com/developers/webhooks.schema.json): every webhook body, chosen by its `event` field

## API

- [GET /api/v1/me](https://backstagepass.com/help/how/automations#get-me): the account the key belongs to
- [GET /api/v1/audience](https://backstagepass.com/help/how/automations#get-audience): audience counts, no people
- [GET /api/v1/audience/export](https://backstagepass.com/help/how/automations#get-export): every person as CSV
- [GET /api/v1/streams](https://backstagepass.com/help/how/automations#get-streams): the 50 newest ended lives and their notification receipts
- [GET /api/v1/passes](https://backstagepass.com/help/how/automations#get-passes): every Pass with its public id (pass_...)
- [POST /api/v1/people](https://backstagepass.com/help/how/automations#post-people): add one person as Invited, with Passes and an expiry queued
- [GET /api/v1/people?email=](https://backstagepass.com/help/how/automations#get-people): one person on your list, Invited or signed in
- [POST /api/v1/people/revoke](https://backstagepass.com/help/how/automations#post-people-revoke): end one Pass, or everything; withdraw an invite
- [POST /api/v1/people/block](https://backstagepass.com/help/how/automations#post-people-block): close every door to one signed-in person
- [POST /api/v1/people/unblock](https://backstagepass.com/help/how/automations#post-people-unblock): undo a block
- [The Invited rule](https://backstagepass.com/help/how/automations#invited): what an added person gets, and when

## Webhooks

- [Events](https://backstagepass.com/help/how/automations#events): 16 moments a webhook can choose, plus `ping`
- [Verify the signature](https://backstagepass.com/help/how/automations#signatures): HMAC-SHA256 over "<t>.<raw body>"
- [Delivery and retries](https://backstagepass.com/help/how/automations#delivery): 4 attempts, pause after 8 straight failures

## Optional

- [Connect without code](https://backstagepass.com/help/how/automations#creator): Zapier, Make, n8n and Pabbly
- [Add and remove people from your tools](https://backstagepass.com/help/how/automations#recipes-people): a buyer onto a Pass, someone off it, without code
- [What an agent cannot do today](https://backstagepass.com/help/how/automations#agent-cannot)