API ReferenceV1Triggers

Get trigger info

Get Trigger Info

Path parameters

triggerNamestringRequired

Headers

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

Response

namestring

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

displayNamestring

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

descriptionstring

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

typestring

Classification or category of the trigger.

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.

payloadmap from strings to any

Sample payload that will be sent when the trigger fires.

configmap from strings to any

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

instructionsstringOptional

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