Getting Started

The Convophi Partner API is a stable REST surface (/api/external/v1) for CRM, ERP, and custom backends. Authenticate with an API key, call Operate endpoints, and receive signed HTTPS webhooks when calls change state.

Architecture

• REST — trigger conversations, read transcripts, manage contacts/campaigns, configure webhooks.
• HTTPS webhooks — primary external notification (conversation.*, campaigns, contacts).
• Optional NATS — partner.events.{customer_id} for enterprise buses.
• Internal only — JetStream conv.events.* is never exposed to partners.

Authentication

Create a key in Govern → Partner API and send X-Api-Key. Details: Authentication.

Next steps

1. Quickstart — integrate in under 10 minutes
2. Govern → Partner API — create webhook endpoints, Test, Recent Deliveries
3. Playground — REST try-it (does not receive webhooks)
4. API Reference