@composio/core / models/Triggers / Triggers

Class: Triggers<TProvider>

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

Trigger (Instance) class /api/v3/trigger_instances

Type Parameters

TProvider

TProvider extends BaseComposioProvider<unknown, unknown, unknown>

Constructors

Constructor

new Triggers<TProvider>(client, config?): Triggers<TProvider>

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

Parameters

client

Composio

config?

ComposioConfig<TProvider>

Returns

Triggers<TProvider>

Methods

create()

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

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

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:231

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:244

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:256

Enable a trigger instance

Parameters

triggerId

string

The id of the trigger instance

Returns

Promise<ManageUpdateResponse>

The updated trigger instance

getType()

getType(slug): Promise<{ }>

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

Retrieve a trigger type by its slug for the provided version of the app Use the global toolkit versions param when initializing composio to pass a toolkitversion

Parameters

slug

string

The slug of the trigger type

Returns

Promise<{ }>

The trigger type object

listActive()

listActive(query?): Promise<{ }>

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

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<TriggersTypeRetrieveEnumResponse>

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

Fetches the list of all the available trigger enums

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

Returns

Promise<TriggersTypeRetrieveEnumResponse>

listTypes()

listTypes(query?): Promise<{ }>

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

List all the trigger types

Parameters

query?

The query parameters to filter the trigger types

Returns

Promise<{ }>

The list of trigger types

subscribe(fn, filters): Promise<void>

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

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:452

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:218

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