Get trigger info

Get Trigger Info

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

Path Parameters

triggerName

string

required

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.

appName

string

required

Name of the app this trigger belongs to.

config

object

required

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

description

string

required

Detailed description of what the trigger does and when it fires.

displayName

string

required

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

name

string

required

Unique identifier of the trigger. Used to reference the trigger in other API calls.

payload

object

required

Sample payload that will be sent when the trigger fires.

type

string

required

Classification or category of the trigger.

instructions

string

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