HelpWave Developer Docs

HelpWave developer docs

Ship against the v1 API without reverse-engineering the CRM.

This site documents the authenticated customers and tickets endpoints currently implemented under CRM v1. It is reference-first, example-heavy, and scoped to behavior visible in the handlers.

Base path: /api/v1

Auth: x-api-key or Authorization: Bearer <key>

Shop scope is always derived from the API key

Start here

Quickstart

See the auth header format, base path, and first request flow.

Open reference

v1/customers

Customers API

Create customers and fetch them back by ID within the API-key shop scope.

Open reference

v1/tickets

Tickets API

Create tickets, fetch them, post comments, and list recent conversation IDs.

Open reference

Shared

Authentication

Understand x-api-key, Bearer fallback, and shop scoping behavior.

Open reference

First request

The fastest end-to-end check is creating a customer with an API key that maps to a HelpWave integration record.

Create a customer

curl -X POST "$BASE_URL/api/v1/customers" \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@example.com",
    "first_name": "Ada",
    "last_name": "Lovelace"
  }'