Browsing the reference
The interactive reference is served by the API itself at api.helpo.support/docs, with the raw OpenAPI document at api.helpo.support/openapi.json. Every route declares its request and response schemas in code, and the document is generated from those declarations, so the reference cannot drift from the implementation.
Authentication
Dashboard endpoints authenticate with your signed-in session, the same cookie the dashboard uses. Standalone API keys for server-to-server use are not yet self-serve; if you need programmatic access before they ship, contact us and we will set it up.
The WordPress plugin and the Shopify app use their own scoped tokens, issued during the connect flow and revocable from Helpo at any time.
Public widget endpoints
A small set of endpoints under /api/widget are public and keyed by a project's site key: the theme config, published help articles and news posts. They return only what a visitor is allowed to see; the system prompt, organization id and AI settings are never exposed.
Getting data out
For pushing events into your own systems today, automation rules with a webhook destination are the supported path. They fire on conversations, messages, takeovers, leads, tickets, form submissions, knowledge changes and SLA breaches.