Skip to content
Talk to our solutions team

API

All routes require a Bearer token and the four CPET headers. The dispatch routes resolve :name in the tenant’s integration registry and reject an unknown or inactive integration.

MethodPathPurpose
GET/listThe tenant’s integrations → {"integrations": { "<name>": {…}, … }}
MethodPathPurpose
GET / POST / PUT / DELETE / PATCH/integration/:name/bff/*proxyRun a connector. The path after /bff is matched against the connector’s path; query params and the JSON or multipart body feed the connector’s request templates. Returns the composed, transformed response

A connector defined with path: /crm/contacts is reached at GET /integration/hubspot/bff/crm/contacts.

MethodPathPurpose
POST/integration/:name/notification/:templateSend one of the integration’s notification templates through the Notifications block. Body is the notification payload
POST/integration/:name/workflow/:workflowStart one of the integration’s Workflows. Body is the workflow input

The integration’s entities are served through the standard data surfaces over the tenant’s datastore:

  • GET/POST /rest/:entity, GET/PUT/PATCH/DELETE /rest/:entity/id/:id, POST /rest/:entity/search
  • GET /schema, /schema/entities/:entity, plus the OpenAPI/JSON-Schema/Zod/CUE exports
  • /admin/data/* migration plane (apply, retention, and locks require superadmin) and the /superadmin/tenant/* cross-tenant mirror

GET /health, GET /ready — unauthenticated.