@composio/core / models/Triggers / Triggers

Class: Triggers

Defined in: ts/packages/core/src/models/Triggers.ts:39

Trigger (Instance) class /api/v3/trigger_instances

Constructors

Constructor

new Triggers(client): Triggers

Defined in: ts/packages/core/src/models/Triggers.ts:43

Parameters

client

Composio

Returns

Triggers

Methods

create()

create(userId, slug, body?): Promise<{ }>

Defined in: ts/packages/core/src/models/Triggers.ts:145

Create a new trigger instance for a user If the connected account id is not provided, the first connected account for the user and toolkit will be used

Parameters

userId

string

The user id of the trigger instance

slug

string

The slug of the trigger instance

body?

The parameters to create the trigger instance

Returns

Promise<{ }>

The created trigger instance

delete()

delete(triggerId): Promise<{ }>

Defined in: ts/packages/core/src/models/Triggers.ts:273

Delete a trigger instance

Parameters

triggerId

string

The slug of the trigger instance

Returns

Promise<{ }>

disable()

disable(triggerId): Promise<ManageUpdateResponse>

Defined in: ts/packages/core/src/models/Triggers.ts:294

Disable a trigger instance

Parameters

triggerId

string

The id of the trigger instance

Returns

Promise<ManageUpdateResponse>

The updated trigger instance

enable()

enable(triggerId): Promise<ManageUpdateResponse>

Defined in: ts/packages/core/src/models/Triggers.ts:306

Enable a trigger instance

Parameters

triggerId

string

The id of the trigger instance

Returns

Promise<ManageUpdateResponse>

The updated trigger instance

getType()

getType(slug): Promise<TriggersTypeRetrieveResponse>

Defined in: ts/packages/core/src/models/Triggers.ts:333

Retrieve a trigger type by its slug

Parameters

slug

string

The slug of the trigger type

Returns

Promise<TriggersTypeRetrieveResponse>

The trigger type object

listActive()

listActive(query?): Promise<{ }>

Defined in: ts/packages/core/src/models/Triggers.ts:94

Fetch list of all the active triggers

Parameters

query?

The query parameters to filter the trigger instances

Returns

Promise<{ }>

List of trigger instances

Throws

If the parameters are invalid

Throws

If the client is not authenticated

Example

1 const triggers = await triggers.listActive({
2   authConfigIds: ['123'],
3   connectedAccountIds: ['456'],
4 });

listEnum()

listEnum(): Promise<string>

Defined in: ts/packages/core/src/models/Triggers.ts:344

Fetches the list of all the available trigger enums

This method is used by the CLI where filters are not required.

Returns

Promise<string>

listTypes()

listTypes(query?): Promise<TriggersTypeListResponse>

Defined in: ts/packages/core/src/models/Triggers.ts:322

List all the trigger types

Parameters

query?

TriggersTypeListParams

The query parameters to filter the trigger types

Returns

Promise<TriggersTypeListResponse>

The list of trigger types

subscribe(fn, filters): Promise<void>

Defined in: ts/packages/core/src/models/Triggers.ts:440

Subscribe to all the triggers

Parameters

fn

(_data) => void

The function to call when a trigger is received

filters

The filters to apply to the triggers

Returns

Promise<void>

Example

1 triggers.subscribe((data) => {
2   console.log(data);
3 }, );

unsubscribe()

unsubscribe(): Promise<void>

Defined in: ts/packages/core/src/models/Triggers.ts:519

Unsubscribe from all the triggers

Returns

Promise<void>

Example

1 composio.trigger.subscribe((data) => {
2   console.log(data);
3 });
4 
5 await triggers.unsubscribe();

update()

update(triggerId, body): Promise<{ }>

Defined in: ts/packages/core/src/models/Triggers.ts:260

Update an existing trigger instance

Parameters

triggerId

string

The Id of the trigger instance

body

The parameters to update the trigger instance

Returns

Promise<{ }>

The updated trigger instance response