API ReferenceSource Connections

Create

Create a new source connection. The authentication configuration determines the flow: - DirectAuthentication: Immediate creation with provided credentials - OAuthBrowserAuthentication: Returns shell with authentication URL - OAuthTokenAuthentication: Immediate creation with provided token - AuthProviderAuthentication: Using external auth provider BYOC (Bring Your Own Client) is detected when client_id and client_secret are provided in OAuthBrowserAuthentication. sync_immediately defaults: - True for: direct, oauth_token, auth_provider - False for: oauth_browser, oauth_byoc (these sync after authentication)

Authentication

x-api-keystring
API Key authentication via header

Headers

X-Framework-NamestringOptional
X-Framework-VersionstringOptional

Request

This endpoint expects an object.
short_namestringRequired

Source identifier (e.g., ‘slack’, ‘github’)

readable_collection_idstringRequired
Collection readable ID
namestring or nullOptional4-42 characters

Connection name (defaults to ‘{Source Name} Connection’)

descriptionstring or nullOptional<=255 characters
Connection description
configmap from strings to any or nullOptional

Source-specific configuration

scheduleobject or nullOptional
Schedule configuration for syncs.
sync_immediatelyboolean or nullOptional

Run initial sync after creation. Defaults to True for direct/token/auth_provider, False for OAuth browser/BYOC flows (which sync after authentication)

authenticationobject or nullOptional

Authentication config (defaults to OAuth browser flow for OAuth sources)

redirect_urlstring or nullOptional

URL to redirect to after OAuth flow completes (only used for OAuth flows)

Response

Successful Response
idstringformat: "uuid"
namestring
descriptionstring or null
short_namestring
readable_collection_idstring
statusenum

Source connection status enum - represents overall connection state.

created_atstringformat: "date-time"
modified_atstringformat: "date-time"
authobject
Authentication information.
configmap from strings to any or null
scheduleobject or null
Schedule information.
syncobject or null
Sync execution details.
sync_idstring or nullformat: "uuid"
ID of the associated sync
entitiesobject or null
Entity state summary.

Errors