List triggers

List triggers

Authorizations

x-api-key

string

header

required

API key for authentication, you can easily get it from the dashboard after login or if you are using CLI, you can get it from the composio whoami command

Query Parameters

appNames

string

Comma-separated list of app names to filter connections by. You can get the app names from the name field in the response of the GET /api/v1/apps endpoint.

connectedAccountIds

string

Comma-separated list of connected account IDs to filter triggers by. Returns all the possible triggers you can setup for these connected accounts. You can get the connected account IDs from the id field in the response of the GET /api/v1/connections endpoint.

triggerIds

string

Comma-separated list of trigger names to filter triggers by. You can get the trigger names from the name field in the response of the GET /api/v1/triggers endpoint.

integrationIds

string

Comma-separated list of integration IDs to filter triggers by. You can get the integration IDs from the id field in the response of the GET /api/v1/integrations endpoint.

showEnabledOnly

boolean

deprecated

When set to true, returns only enabled triggers. This field is deprecated and will be removed in future versions.

Response

200 - application/json

appId

string

required

Unique identifier of the app this trigger belongs to. You can get this from the id field in the response of the GET /api/v1/apps endpoint.

appKey

string

required

Unique key identifying the app this trigger belongs to.

appName

string

required

Name of the app this trigger belongs to.

display_name

string

required

Human-readable name of the trigger shown in the UI.

name

string

required

Unique identifier of the trigger. This is used to reference the trigger in other API calls.

config

object

Configuration parameters required for the trigger. Structure varies based on trigger type.

count

number

Number of times this trigger has been activated.

description

string

Detailed description of what the trigger does.

enabled

boolean

Indicates whether the trigger is currently enabled.

instructions

string

Step-by-step instructions on how to set up and use this trigger.

logo

string

URL of the trigger's icon or logo.

payload

object

Sample payload that will be sent when the trigger fires.

type

string

Classification or category of the trigger.