Provider IDs
Use the currently enabled public provider IDs below when calling integration routes.Use
google-mail for direct API requests. The CLI also accepts gmail as a convenience alias.List Integrations
boolean
default:"false"
When
true, only returns currently connected integrations.Example
Response
Get Setup Capabilities
string
Optional public provider ID or CLI alias. When omitted, returns all provider capabilities.
Response
Run Provider Setup Step
postConnectSteps reports a supported follow-up such as CRM mappings or webhooks.
Request Body
string
required
Public provider ID from setup capabilities.
string
required
Follow-up step token, such as
mappings or webhooks.object
Optional step-specific config. CRM mappings use
{ "mappings": [...] }; Stripe webhooks can use { "webhookSecret": "whsec_..." }; Fireflies webhooks can use { "webhookSecret": "..." }.config_required response. Webhook setup returns the URL, headers/secrets, required events, and status needed for manual provider setup without creating a browser session.
Connect Integration
Request Body
string
required
Public provider ID from the provider table.
object
Required for direct credential connections. Omit this field to create a browser-auth connection session.
Direct Credential Response
Browser Session Response
connectUrl in a browser where the user can complete the provider connection, then poll the connect status route with sessionId. Direct credential setup, such as Pylon API-token setup, returns the direct credential response and does not create a session ID.
Errors
Invalid providers or malformed JSON return400. Connection-limit failures return 403:
Poll Connection Status
string
required
Session ID returned by
POST /api/integrations/connect.Response
status is one of pending, connected, failed, or expired. Failed responses may include error.
Disconnect Integration
Request Body
string
required
Public provider ID from the provider table.
Response
404:
Get Sync Status
string
required
Public provider ID from the provider table.