# Campfire Partner API

Campfire Partner API connects a product's customer-owned WhatsApp Business numbers to a managed Campfire workspace. Campfire owns the Meta app, webhook endpoint, encrypted provider credentials, delivery workers, and support inbox.

## Start here
- Partner quickstart: https://campfire.is/docs/partners
- OpenAPI 3.1: https://campfire.is/openapi/partners-v2.yaml
- Partner API base: https://api.campfire.is/api/partners/v2

## Authentication and invariants
- Use Authorization: Bearer CAMPFIRE_PARTNER_API_KEY.
- All partner IDs are opaque prefixed IDs (mw_, msg_, conv_, sl_).
- POST partner commands require Idempotency-Key (8–128 chars).
- Customer setup links require a workspace returnUrlAllowlist match; the bearer secret is carried in the hosted URL fragment and never appears in normal server request logs.
- WhatsApp messages use the canonical delivery spine. A successful command acknowledgement is not a delivered receipt.

## Supported flows
- Create/list managed workspaces.
- Create/list/revoke customer-owned WhatsApp setup links.
- Read installation state and create a managed installation action.
- Send template/text/media/interactive commands subject to consent, 24-hour window, approved template aliases, and workspace kill switches.
- Pull ordered partner events, issue scoped surface sessions, and query a delivery timeline by Meta wamid.

## Delivery triage
GET /workspaces/{workspaceId}/logs?wamid={Meta provider message id} returns no message body. It merges command acceptance, durable delivery job state, Meta receipt state/error code, and signed partner-webhook transport attempts.

## Boundaries
- Meta Tech Provider status and broad sandbox-number provisioning are operational gates; do not claim either from this API.
- The current public connection type is whatsapp.
- The Platform API extends Partner v2; it does not create a parallel WhatsApp stack.