Core API surfaces
- Authentication endpoints (
/api/auth/*) for token lifecycle. - Resource endpoints (
/api/contacts,/api/conversation,/api/messages,/api/applications) for core workflow operations. - Organization and user endpoints (
/api/organizations,/api/user) for account-level configuration. - Automation endpoints (
/api/automations,/api/workflows,/api/pipelines) for orchestration.
Example inbound integration flow
- Source system sends inbound event payload to
POST /api/webhook/outreach. - API validates and normalizes payload fields.
- Event is mapped to contact/application/conversation context.
- Automation and assignment logic is applied.
- Resulting state is available through resource endpoints.
Realtime messaging flow
- Client authenticates and obtains bearer token.
- Client sends/receives message events through API and realtime channels.
- Conversation state updates are persisted and queryable by API.
- Feedback loops (for example CSAT) are exposed via conversation endpoints.