API Endpoint Trigger

What it does

Creates a dedicated API endpoint on the route. Calling it runs the workflow synchronously and returns the result in the response.

Configuring it

• Allowed Methods — required. Which HTTP methods the endpoint accepts (GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD). Defaults to POST.
• Endpoint — the path to match. Defaults to /; use * to match all paths.

Batch jobs

An API Endpoint trigger can optionally run as a background batch job instead of synchronously — the call returns immediately with an executionId, and progress/results are polled via the /batch-jobs API. Configurable execution timeout (must stay under 900 seconds) and a concurrency policy (queue behind the current run, or allow parallel executions).

Examples

A single POST endpoint

{ "allowedMethods": ["POST"], "endpoint": "/orders" }

Accept GET and POST on every path under this route

{ "allowedMethods": ["GET", "POST"], "endpoint": "*" }

See also

• GraphQL Trigger — Creates a native GraphQL endpoint with schema configuration and automatic field filtering.
• Webhook Trigger — Triggered by incoming HTTP webhook requests, with optional async execution, retry, and throttling.
• Schedule Trigger — Triggered on a scheduled basis using cron expressions.
• File Event Trigger — Triggered when a file is created, updated, or deleted in the store's managed file storage.