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.

Example:

"your-api-key"

version_id
string

Optional: Specific version to trigger.

If not provided, triggers the latest version of the workflow. This allows you to execute specific versions for testing or comparison.

Example:

"v1"

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"

Response

Workflow execution started

Response from triggering a workflow execution

execution_id
string

Unique execution identifier (only present for successful triggers)

Example:

"exec_xyz789"

status
enum<string>

Execution status immediately after triggering.

  • queued: Workflow execution has been queued and will start shortly
  • failed: Trigger failed due to validation or system error
Available options:
queued,
failed
Example:

"queued"

started_at
string<date-time>

RFC3339 timestamp when the execution was queued (only present for successful triggers)

message
string

Error message (only present when status is "failed")

Example:

"invalid input: missing required field"

Last modified on July 27, 2026