Skip to main content
POST
Add connection after OAuth for a workflow

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
workflowId
string<uuid>
required

Workflow (agent) ID to attach the connection to

Example:

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

connectionId
string<uuid>
required

Connected account ID returned after OAuth (?connectionId= on the callback URL)

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

Connection linked successfully

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"