Integrations

Start an integration authorization flow

Creates a provider auth flow and returns an oauth_url the user opens to authorize. Broker-routed providers (Composio custody) may additionally require declared connect params (see requestBody); native X uses OAuth 2.0 confidential-client PKCE with encrypted token custody, and users only approve in x.com — they never supply developer keys. Shannon stores no broker credentials, only an opaque reference. A provider missing server-side configuration returns provider_unavailable without creating pending state.

post/api/v1/integrations/{provider}/connect

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/integrations/{provider}/connect
  • Auth: API key in header X-API-Key

Path parameters

providerstring required

Provider slug (e.g. notion, figma, google_calendar)

Request body

paramsobject

Provider-declared connect parameters; undeclared keys are ignored.

Response

Authorization flow started: open oauth_url, then poll GET /api/v1/integrations/{id} until status becomes active. status is always "pending" here; the field is kept so clients can switch on it rather than infer the flow from oauth_url presence.

connection_idstring uuid
oauth_urlstring

URL the user opens to authorize with the vendor

status'pending'

Changes

No recorded changes to this operation across all 1 revision of this API.