Skip to main content

​
Event

flows.tasks.canceled
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

FieldTypeDescription
eventstringAlways flows.tasks.canceled
event_idstringUnique delivery ID — use to deduplicate retries
organization_idstringID of the organization
timestampstringISO 8601 UTC timestamp of the event
dataobjectEvent-specific payload (see below)

​
Data Object

FieldTypeDescription
task_idstringUnique identifier of the canceled task
workflow_idstringID of the parent workflow
workflow_namestringHuman-readable workflow name
initiated_bystringEmail of the user who originally initiated the task
canceled_bystringEmail of the user who canceled the task
canceled_atstringISO 8601 UTC timestamp of cancellation
reasonstringOptional cancellation reason provided by the user
step_at_cancellationobjectThe step the task was on when it was canceled

​
Step At Cancellation Object

FieldTypeDescription
step_idstringUnique identifier of the step
step_namestringHuman-readable step name