HelpWave Developer DocsHelpWave Dev DocsReference-first docs for v1 customers and tickets APIs

Authentication

The v1 auth helper accepts either x-api-key or Authorization: Bearer <key>. Once the key is resolved, the CRM looks up a helpwaveIntegration record by internalApiKey and extracts shopDomain from that match.

If no key is present, the API returns HTTP 401 with Missing API key. If the key does not map to an integration, the API returns HTTP 401 with Unauthorized - Invalid API key.

Accepted headers

Primary header
x-api-key: <YOUR_API_KEY>
Bearer fallback
Authorization: Bearer <YOUR_API_KEY>

Failure payload

401 example
{
  "error": "Unauthorized - Invalid API key"
}