Compass has no API of its own to document — it's purely a client of the contract every other product in the suite already speaks. This page explains the read contract instead.
Any product that wants to show up on a Compass dashboard implements two authenticated, read-only endpoints - the same two every product in this suite already has, for the same reason Relay's "Test Connection" button needs them:
GET /integrations/v1/ping - confirms the API key is valid and returns which tenant it belongs to: { ok: true, tenant: { id, name }, product: "..." }.GET /integrations/v1/summary - a handful of real counts from that product's own data, shaped as { ok: true, tenant: {...}, product: "...", metrics: [ { label, value }, ... ] } - a generic shape Compass can render for any product without knowing anything about what it does.Both are authenticated the same way every write endpoint in the suite already is: an X-Integration-Key: <key> header, generated on that product's own Settings → Integrations page (Settings → API access, for Relay).
Compass has no write endpoints of its own, and never calls a write endpoint on a connected product. It cannot create a lead, send a WhatsApp message, place an order, publish a post, or start a workflow. "Refresh" is the only action a connection card triggers, and it only ever calls the two read endpoints above.
Pick "Custom" as the product when adding a connection in Settings. Compass doesn't need to recognize the product - it just needs those two endpoints to respond the way this page describes.