Get Trigger Instances Active

Authentication

x-api-keystring

API key authentication

Query parameters

connected_account_idslist of stringsOptional

Array of connected account IDs to filter triggers by

auth_config_idslist of stringsOptional

Array of auth config IDs to filter triggers by

trigger_idslist of stringsOptional

Array of trigger IDs to filter triggers by

trigger_nameslist of stringsOptional

Array of trigger names to filter triggers by

connectedAccountIdslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use connected_account_ids instead.

authConfigIdslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use auth_config_ids instead.

triggerIdslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use trigger_ids instead.

show_disabledbooleanOptionalDefaults to false

When set to true, includes disabled triggers in the response.

triggerNameslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use trigger_names instead.

pagedoubleOptional>=1Defaults to 1

Page number for pagination. Starts from 1.

showDisabledbooleanOptionalDefaults to falseDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use show_disabled instead.

deprecatedConnectedAccountUuidslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use connected_account_ids instead.

deprecatedAuthConfigUuidslist of stringsOptionalDeprecated

DEPRECATED: This parameter will be removed in a future version. Please use auth_config_ids instead.

limitdoubleOptional

Number of items per page, max allowed is 1000

cursorstringOptional

Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Response

Successfully retrieved active trigger instances

itemslist of objects

total_pagesdouble

current_pagedouble

total_itemsdouble

next_cursorstring or null

1	import requests
2
3	url = "https://backend.composio.dev/api/v3/trigger_instances/active"
4
5	headers = {"x-api-key": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"items": [
3	{
4	"id": "trg_9x8y7z6w5v4u3t2s1r",
5	"connected_account_id": "acc_1234567890abcdef",
6	"trigger_name": "new_email_received",
7	"connected_account_uuid": "b7c9d8e1-2f3a-4b5c-9d0e-1f2a3b4c5d6e",
8	"user_id": "user_9876543210fedcba",
9	"trigger_config": {
10	"folder": "inbox",
11	"unread_only": true
12	},
13	"state": {
14	"last_checked": "2024-06-01T12:00:00Z",
15	"pending_emails": 3
16	},
17	"updated_at": "2024-06-01T12:05:00Z",
18	"disabled_at": null,
19	"disabledAt": null,
20	"connectedAccountId": "acc_1234567890abcdef",
21	"triggerName": "new_email_received",
22	"updatedAt": "2024-06-01T12:05:00Z",
23	"triggerConfig": {
24	"folder": "inbox",
25	"unread_only": true
26	},
27	"uuid": "a3f47b9e-8c2d-4f1a-9b7e-2d5f6c8a9e12",
28	"trigger_data": "{\"email_subject\":\"Welcome to Composio!\",\"sender\":\"noreply@composio.dev\"}",
29	"deprecated": {
30	"createdAt": "2023-12-15T09:30:00Z"
31	}
32	}
33	],
34	"total_pages": 5,
35	"current_page": 1,
36	"total_items": 87,
37	"next_cursor": "eyJwYWdlIjoxLCJsaW1pdCI6MjB9"
38	}

Authentication

Query parameters

Response

Errors