Skip to content
Beta

Resources Support

Support

How to get help with the Totem API, what to include in a request, and what to do if a key leaks.

How to reach us

The Totem team handles API support requests.

  • From Totem. An administrator of your team opens Help in the Totem app and sends a support request. It is the fastest route, because the request arrives tied to your team.
  • By email. Write to hello@totemstudio.ai. A developer working for a customer can write too: say which customer and which integration the question is about.

There is no separate API status page yet. If the API seems down, call GET /v1/health, which needs no key, and tell us what it answered.

What to include

  • the Totem-Request-Id of the response that failed, if it has one, and its Totem-Release header, if it has one;
  • the time of the request, in UTC;
  • the method and the path, such as GET /v1/sync/changes;
  • the HTTP status and the error's code;
  • the integration's name and the last four characters of its key;
  • the team id (team_…) and the ids of the records concerned.

What never to send

Never send a secret key, in full or in part beyond its last four characters. Do not paste personal data from responses, such as names, phone numbers or email addresses: ids and request ids are enough for us to investigate.

If a key leaks

Choose Roll key at once in Settings → Developers and tick This key may have been compromised, so the old key is revoked with no grace period. Then tell us the integration's name, when you think the key leaked and who or what had access to it. Authentication explains rolling and revoking.

To report a suspected vulnerability in the API, these docs or the TypeScript SDK, write privately to hello@totemstudio.ai, as Security and personal data explains.

Notices

The API is in Beta. The changelog lists changes under the date they shipped, and Conventions explains what can change during the Beta.

API version 1.0a