API ReferenceV1Triggers

List triggers

List triggers

Headers

x-api-keystringRequired
x-org-api-keystringRequired
x-api-keystringRequired

Query parameters

appNamesstringOptional
connectedAccountIdsstringOptional
triggerIdsstringOptional
triggerNamesstringOptional
integrationIdsstringOptional
showEnabledOnlybooleanOptional

Response

namestring

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

display_namestring

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

appKeystring

Unique key identifying the app this trigger belongs to.

appIdstring

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.

appNamestring

Name of the app this trigger belongs to.

descriptionstringOptional

Detailed description of what the trigger does.

enabledbooleanOptional

Indicates whether the trigger is currently enabled.

configmap from strings to anyOptional

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

payloadmap from strings to anyOptional

Sample payload that will be sent when the trigger fires.

countdoubleOptional

Number of times this trigger has been activated.

instructionsstringOptional

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

typestringOptional

Classification or category of the trigger.