Skip to main content

Event format

Events follow an object.action naming convention. Every event is delivered with the same envelope. The data field contains a summary of the resource at the time of the event.
Fields that have no value yet are delivered as empty strings. For example, a task run that is not part of a workflow has "workflow_id": "". One event type falls outside the catalog below: test.ping, with a data payload of {"ok": true}. It’s only delivered when you send a test event to a destination and isn’t a subscribable type.

Agent events

Source events

Credential events

Session events

Task events

Also fired when a task graduates to a new status after successful runs, for example learning to test.

Task run events

Task run payloads share the same fields. result is empty until the run reaches a final result, then becomes success or failure. runtime_ms appears once the run has finished. workflow_id is empty for runs that are not part of a workflow. A run created by a workflow step also carries workflow_run_id and step, the name of the step that created it, and a run created by a trigger carries trigger_id. All three are omitted otherwise.
Includes an interaction object describing the input to collect. See Handling interactions for the full interaction object reference.

Workflow events

Workflow payloads carry the definition’s identity, not its steps. Fetch GET /v2/workflows/{workflow_id} for the current definition.

Workflow run events

Every status transition emits exactly once. Workflow run payloads share the same fields. result is null until the run reaches a terminal status, then becomes success, failure, or unknown (and stays null for a canceled run). session_id is the session every step of the run executes in, and trigger_id names the trigger that created the run, or null for runs created through the API. Per-step detail isn’t in the payload; fetch GET /v2/workflow-runs/{workflow_run_id} for step statuses and outputs, or subscribe to the task_run.* events each step emits.

Storage events

Event destination events