Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Integrations API
Connect third-party SaaS apps (Salesforce, HubSpot, Shopify, Stripe, Zendesk, Intercom, …) and pull their data into Orbit for use in flows, AI agents, and contact enrichment. Powered by Nango under the hood; auth, refresh, rate limiting, and provider-specific quirks are handled for you. Base path:/v1/integrations
Authentication: API key (X-API-Key) or session JWT.
Connections
| Method | Path | Purpose |
|---|---|---|
GET | /v1/integrations | List connected integrations |
POST | /v1/integrations/connect | Initiate an OAuth connect flow |
GET | /v1/integrations/{id}/status | Connection health + last sync |
DELETE | /v1/integrations/{id}/disconnect | Disconnect (revokes provider tokens) |
Sync & data
| Method | Path | Purpose |
|---|---|---|
POST | /v1/integrations/{id}/sync | Trigger a sync now |
GET | /v1/integrations/{id}/data | Read synced records |
Inbound webhook
Nango posts auth + sync events toPOST /v1/integrations/webhooks/nango — internal only. You don’t call this directly.
Example — initiate a Salesforce connection
auth_url — redirect the user to it. After consent, Nango redirects to return_url with the connection ID.