Integrations — developer & admin guide

This section documents how external systems connect to Call Helm as the product exists today. It is written from the integration code itself, so if a capability is not listed here, it is not available yet. For everyday, non-technical how-to (using the app, calling, messaging, billing), see the Help Center's user guide.

What you can integrate today

Integration	Status	What works today	Guide
3CX (PBX CRM connector)	Available — partial	Call Helm acts as the CRM inside your 3CX phone system: caller lookup / screen pop and contact search work. The template also wires contact creation from 3CX and call journaling, but those two operations are not functional today (the handlers don't match the current database schema and return an error) — treat them as planned.	3CX integration

That is the complete list. 3CX is the only integration with a configurable connection and a customer-facing credential.

How authentication works

The only programmatic credential Call Helm issues to customers is the 3CX integration API key — a value beginning with 3cx_ that an Organization Admin generates in Settings → Integrations → 3CX.

It is scoped to the 3CX connector. It authenticates the five endpoints under /api/3cx/ that the 3CX server calls (contact lookup, search, create, call journaling, and the XML template download). It is not a general-purpose API key: it does not grant access to any other /api/ route, and there is no separate "API keys" feature.
One key per organization. Generating a new key replaces the previous one immediately.
Send it in the x-api-key request header (the XML template configures 3CX to do this for you).

Details, rotation, and security notes are in the 3CX guide.

What is not available (please don't build against it)

No public REST API. Call Helm does not currently offer a general customer API — there are no customer API keys, no versioned public endpoints, and no OpenAPI spec. The routes under /api/ other than /api/3cx/* are internal to the web app (session-authenticated) and may change without notice. Some earlier plan descriptions mentioned "REST API access"; that claim has been withdrawn.
3CX contact creation and call journaling — wired in the template, not functional in the current release (see the 3CX guide's Known issues). Planned.
No CRM connectors for Salesforce, HubSpot, Pipedrive, or Zapier. The Integrations tab shows placeholder cards for some of these; they are not functional.
No webhooks / event alerts yet. Planned: a design for outbound webhooks (for example, call.completed filtered by sentiment, delivered with HMAC signatures and retries) exists as a roadmap spec, but nothing is built or exposed. Do not rely on any webhook URL or event format until this page documents it as available.
No bring-your-own telephony provider. Voice and SMS run on Call Helm's own carrier integration; the "Twilio" card in Settings → Integrations is a placeholder and there is no provider-connection flow.

Getting help

Email hello@callhelm.com with your organization name, the endpoint or feature involved, and (for 3CX) the 3CX Management Console log entry or the time of the failing request. The 3CX settings page's activity counters (lookups and searches) help us correlate.