Skip to main content
This package allows you to track server-side customer events.

Identify users

Request headers:
Please replace YOUR_SECRET_API_TOKEN with your secret API token, which can be found in your project settings -> API token. Request content:
The optional value field is the contact’s MRR: monthly recurring revenue, in your billing currency, in major units. Set companyId to associate the user with a company. The optional companyName is a fallback label and never overwrites a name set authoritatively via the Companies endpoint (below).

Last activity update

By default the last activity gets updated to new Date(). You can prevent this by adding ?preventLastActivityUpdate=true to your request params.

Companies

Create, update, read and delete companies. Companies hold authoritative attributes (plan, value, SLA, address and custom data) shown in the dashboard and used for company-level SLAs. All endpoints use the same Api-Token header as above.

Create or update a company

{companyId} is your own immutable identifier for the company (URL-encode it) — the same id you pass to identify as companyId. The company is created on first use and updated on subsequent calls. Request headers:
Request content:
sla is the response-time SLA in seconds. Unknown fields are ignored; companyId cannot be set from the body. Returns the saved company. value is the company’s MRR: monthly recurring revenue, in your billing currency, in major units. Kai PM scores a company account with the maximum of the company value and its members’ contact values, counted once per company. Update it from your billing webhooks; set 0 on cancellation.

Get a company

Returns the company, or 404 if it does not exist.

Delete a company

Permanently deletes the company. Its members (contacts) and their conversations are not deleted.

Track events

Request headers:
Request content:

Rate limit

Please note that the identify and track APIs enforce a rate limit of 1500 requests / 60 seconds per API token. If you exceed the limit, requests are rejected with 429 Too Many Requests and the token is blocked for a short period before requests are accepted again.