Skip to main content
POST
Trigger public workflow version

Path Parameters

nickname
string
required

Organization nickname (without @ prefix)

Example:

"acme-corp"

slug
string
required

Workflow slug

Example:

"my-image-generator"

versionID
string
required

Version identifier

Example:

"v1"

Body

application/json
api_key
string
required

Your eachlabs API key. The public trigger authenticates via this body field instead of an Authorization header; an X-API-Key header is read as a fallback. The organization owning the key is billed for the run.

Example:

"your-api-key"

inputs
object

Input parameters defined in the workflow definition for the workflow

Example:
webhook_url
string<uri>

Optional webhook URL for execution completion notifications.

When provided, the engine will POST an ExecutionDetails payload to this URL when the workflow finishes (either successfully or with an error).

See the Webhooks section for detailed information about webhook behavior and payload structure.

Example:

"https://your-api.com/webhooks/workflow-completed"

webhook_secret
string

Optional: shared secret used to verify webhook deliveries.

Example:

"whsec_example"

Response

Workflow execution started

Response from triggering a workflow execution. Failures return an error status with an {"error": "..."} body instead.

execution_id
string
required

Unique execution identifier

Example:

"e2dba2bb-bc1d-4651-b6bf-fbbbebdee104"

status
enum<string>
required

Execution status immediately after triggering: the execution has been queued and will start shortly.

Available options:
queued
Example:

"queued"

Last modified on August 17, 2026