workflow-webhooks

Trigger a workflow run through a webhook API key.

Changed on

Validates the request body against the saved workflow input contract, then creates a direct WorkflowRun for the addressed tenant, agent, and workflow. Every request body is interpreted as JSON regardless of its Content-Type header. Authentication uses the X-API-Key header.

post/api/workflow/{agentName}/{workflowName}/webhook

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflow/{agentName}/{workflowName}/webhook
  • Auth: API key in header X-API-Key

Path parameters

agentNamestring required

Agent name.

workflowNamestring required

Workflow name scoped to an agent.

Query parameters

timeout_secondsinteger

Timeout for the created WorkflowRun.

Request body

boolean required
OR
number required
OR
string required
OR
OR
object required

Response

Workflow run accepted.

namestring required

WorkflowRun resource name.

workflow_namestring required

Workflow name scoped to an agent.

trigger_type'Schedule' | 'Webhook' required
schedule_namestring

WorkflowSchedule resource name.

timeout_secondsinteger required
status'Pending' | 'Running' | 'Succeeded' | 'Failed' | 'Unacked' required
reasonstring required
created_atstring date-time required
started_atstring date-time
completed_atstring date-time
duration_secondsinteger

Changes

  • d197d7b57b8dRevision changes
    • info

      added the non-success response with the status

  • d44ac82920cdRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status