Skip to main content
POST
Create connected account (provider dispatch)

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Headers

x-username
string
default:(project default user)

External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.

Body

application/json

Auth config id and connection state; routed to the matching provider.

authConfig
object
required
connection
object
required
validateCredentials
boolean
default:false

Validate credentials flag

Example:

true

connectedAccountId
string

Internal Flowra connected account id

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Consent link token (oauth:consent:v1:*). Used after the user returns from /connect/:token.

Example:

"oauth:consent:v1:abc123"

Response

201 - application/json

Provider-specific result (e.g. redirect URI for Composio initiate).

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"

data
object
required
Example: