Documentation Index
Fetch the complete documentation index at: https://docs.chamelio.ai/llms.txt
Use this file to discover all available pages before exploring further.
Event
This event fires when a task is canceled — either via the Cancel Task API or through the Chamelio web application. A canceled task cannot be resumed.
Payload Example
{
"event": "flows.tasks.canceled",
"event_id": "evt_01HXYZAA11223344",
"organization_id": "org_abc123",
"timestamp": "2025-06-07T09:45:00Z",
"data": {
"task_id": "task_def456",
"workflow_id": "wf_contract_review",
"workflow_name": "Contract Review",
"initiated_by": "john.doe@example.com",
"canceled_by": "admin@example.com",
"canceled_at": "2025-06-07T09:45:00Z",
"reason": "Contract terms changed — task restarted from scratch",
"step_at_cancellation": {
"step_id": "step_2",
"step_name": "Legal Approval"
}
}
}
Payload Fields
Envelope
| Field | Type | Description |
|---|
event | string | Always flows.tasks.canceled |
event_id | string | Unique delivery ID — use to deduplicate retries |
organization_id | string | ID of the organization |
timestamp | string | ISO 8601 UTC timestamp of the event |
data | object | Event-specific payload (see below) |
Data Object
| Field | Type | Description |
|---|
task_id | string | Unique identifier of the canceled task |
workflow_id | string | ID of the parent workflow |
workflow_name | string | Human-readable workflow name |
initiated_by | string | Email of the user who originally initiated the task |
canceled_by | string | Email of the user who canceled the task |
canceled_at | string | ISO 8601 UTC timestamp of cancellation |
reason | string | Optional cancellation reason provided by the user |
step_at_cancellation | object | The step the task was on when it was canceled |
Step At Cancellation Object
| Field | Type | Description |
|---|
step_id | string | Unique identifier of the step |
step_name | string | Human-readable step name |
