API ReferenceTriggers

List active triggers

Markdown
GET
/api/v3/trigger_instances/active

Retrieves all active trigger instances for your project. Triggers listen for events from connected accounts (e.g., new emails, Slack messages, GitHub commits) and can invoke webhooks or workflows. Use filters to find triggers for specific users, connected accounts, or trigger types.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Query Parameters

user_ids?|null

Array of user IDs to filter triggers by

connected_account_ids?|null

Array of connected account IDs to filter triggers by

auth_config_ids?|null

Array of auth config IDs to filter triggers by

trigger_ids?|null

Array of trigger IDs to filter triggers by

trigger_names?|null

Array of trigger names to filter triggers by. Case-insensitive (internally normalized to uppercase).

connectedAccountIds?|nullDeprecated

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

authConfigIds?|nullDeprecated

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

triggerIds?|nullDeprecated

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

show_disabled?boolean|null

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

Defaultfalse
triggerNames?|nullDeprecated

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

showDisabled?boolean|nullDeprecated

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

Defaultfalse
deprecatedConnectedAccountUuids?|nullDeprecated

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

deprecatedAuthConfigUuids?|nullDeprecated

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

limit?number|null

Number of items per page, max allowed is 1000

cursor?string

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 Body

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/trigger_instances/active"
{
  "items": [
    {
      "uuid": "string",
      "id": "string",
      "connected_account_id": "string",
      "trigger_name": "string",
      "connected_account_uuid": "string",
      "user_id": "string",
      "trigger_data": "string",
      "trigger_config": {
        "property1": null,
        "property2": null
      },
      "state": {
        "property1": null,
        "property2": null
      },
      "updated_at": "string",
      "disabled_at": "string",
      "disabledAt": "string",
      "connectedAccountId": "string",
      "triggerName": "string",
      "updatedAt": "string",
      "triggerConfig": {
        "property1": null,
        "property2": null
      },
      "deprecated": {
        "createdAt": "string"
      }
    }
  ],
  "next_cursor": "string",
  "total_pages": 0,
  "current_page": 0,
  "total_items": 0
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}