Trigger is an event or condition that starts the execution of a workflow. Triggers are defined at the top of a Workflow JSON.

​
Available Triggers

​
HTTP

The HTTP trigger listens for HTTP requests, making it ideal for creating APIs or responding to webhooks.

​
Workflow setup

GET Example
"trigger": {
    "http": {
        "method": "GET",
        "path": "/example",
        "accept": "application/json"
    }
}
​
method
GET POST PATCH PUT DELETE

HTTP method for the trigger

​
path
string

Endpoint path where the workflow is accessible.

​
accept
string

Specifies the acceptable response content type (e.g., application/json)

​
CTX

CTX Structure
{
    "id": "",
    "config": {},
    "request": {},
    "response": {},
    "error": {},
    "logger": ""
}
​
id
string

Request ID autogenerated for each trigger invocation

​
config
Object

Includes all the nodes configuration added in the workflow.

​
request
Object

An http request object containing headers, body, and query parameters. It follow http.IncomingMessage interface.

​
response
Object

An http response object containing headers, body, and query parameters. It follow http.Outgoingmessage interface.

​
error
Object

An error object containing error message

​
logger
DefaultLogger

An instance of internal logger object. For more information, check Logger

​
Custom Triggers

If you want to extend the functionality via custom triggers, check out our contribution guidelines to learn how to create and share your custom triggers with the community.

Executing WorkflowsCLI