Integration API

Clarm exposes a small set of integration surfaces for widget bootstrapping, tracking, and operational configuration. Most customers use the loader snippet, tracking helper, and dashboard-managed integrations rather than building against a large public REST API.

Canonical base origin

Base URLtext

https://app.clarm.com

Supported integration surfaces

GET/api/widget/config/:widgetIdPublic widget bootstrap config used by loader.js

POST/api/trackReceives widget and custom tracking events

GET / POST/api/dashboard/api-keysManage org-scoped API keys from an authenticated dashboard session

POST/api/live/webhook-configCreate live webhook or Slack bridge delivery for an agent

What is public vs authenticated

The widget config route is public by design and keyed by widgetId. Dashboard and admin-style routes require either an authenticated dashboard session or an org-scoped API key, depending on the endpoint.

Recommended workflow

For most implementations:

Common patterntext

1. Create and save your widget in the dashboard
2. Embed loader.js with data-widget-id on your site
3. Add identify / purchase tracking with window.ClarmTrack.track(...)
4. Connect Slack, HubSpot, or a custom webhook from Dashboard > Integrations