@composio/core / ConnectionRequest / ConnectionRequest

Class: ConnectionRequest

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:21

Constructors

Constructor

new ConnectionRequest(client, connectedAccountId, status?, redirectUrl?): ConnectionRequest

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:27

Parameters

client

Composio

connectedAccountId

string

status?

ConnectedAccountStatus

redirectUrl?

string

Returns

ConnectionRequest

Properties

id

id: string

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:23

redirectUrl?

optional redirectUrl: string

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:25

status?

optional status: ConnectedAccountStatus

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:24

Methods

toJSON()

toJSON(): Record<string, unknown>

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:131

Returns a JSON-serializable representation of the connection request Excludes the private client property to avoid cyclic reference issues

Returns

Record<string, unknown>

toString()

toString(): string

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:142

Returns a string representation of the connection request

Returns

string

waitForConnection()

waitForConnection(timeout?): Promise<{ }>

Defined in: ts/packages/core/src/models/ConnectionRequest.ts:66

Waits for the connection request to complete and become active.

This method continuously polls the Composio API to check the status of the connection request until it either becomes active, enters a terminal error state, or times out.

Parameters

timeout?

number = 60000

Maximum time to wait in milliseconds before timing out (default: 60 seconds)

Returns

Promise<{ }>

The final connected account response when successful

Throws

If the connected account cannot be found

Throws

If the connection enters a failed, expired, or deleted state

Throws

If the connection request does not complete within the timeout period

Example

1 // Wait for connection with default timeout (60 seconds)
2 try {
3   const connection = await connectionRequest.waitForConnection();
4   console.log('Connection established:', connection.id);
5 } catch (error) {
6   console.error('Connection failed:', error.message);
7 }
8 
9 // Wait for connection with custom timeout (2 minutes)
10 const connection = await connectionRequest.waitForConnection(120000);