Reservation

Accepted

com.twilio.taskrouter.reservation.accepted

(information)

Info

The worker_time_in_previous_activity field began reporting in seconds starting May 21, 2021. Version 2 of the TaskRouter schema added a new worker_time_in_previous_activity_ms field that was not exposed through Event Streams previously. If you want to measure this field in milliseconds, you must use schema version 2.

Reservation Accepted events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.accepted",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Canceled

com.twilio.taskrouter.reservation.canceled

(information)

Info

Reservation Canceled events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.canceled",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Completed

com.twilio.taskrouter.reservation.completed

(information)

Info

Reservation Completed events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.completed",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Created

com.twilio.taskrouter.reservation.created

(information)

Info

Reservation Created events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.created",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Failed

com.twilio.taskrouter.reservation.failed

(information)

Info

Reservation Failed events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.failed",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Rejected

com.twilio.taskrouter.reservation.rejected

(information)

Info

Reservation Rejected events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.rejected",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Rescinded

com.twilio.taskrouter.reservation.rescinded

(information)

Info

Reservation Rescinded events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.rescinded",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Timeout

com.twilio.taskrouter.reservation.timeout

(information)

Info

Reservation Timeout events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.timeout",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.

Wrapup

com.twilio.taskrouter.reservation.wrapup

(information)

Info

Reservation Wrapup events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.taskrouter.reservation.wrapup",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/TaskRouter.WDSEvent/4",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "sid" : "EV0000000000000000000000000000001",
10    "name" : "ReservationCreated",
11    "account_sid" : "AC0000000000000000000000000000001",
12    "account_friendly_name" : "An account name",
13    "parent_account_sid" : "AC0000000000000000000000000000001",
14    "parent_friendly_name" : "Another account name",
15    "timestamp" : "2025-01-01T00:00:00.000Z",
16    "level" : "INFO",
17    "group" : "reservation",
18    "product_name" : "TaskRouter",
19    "publisher" : "Flex Task Assignment",
20    "publisher_metadata" : "{}",
21    "payload_type" : "application/json",
22    "payload" : {
23      "sid" : "EV0000000000000000000000000000001",
24      "eventtype" : "reservation.created",
25      "account_sid" : "AC0000000000000000000000000000001",
26      "timestamp" : "2025-01-01T00:00:00.000Z",
27      "workspace_sid" : "WS0000000000000000000000000000001",
28      "workspace_name" : "Flex Task Assignment",
29      "task_sid" : "WT0000000000000000000000000000001",
30      "task_attributes" : "{}",
31      "task_age" : 31088,
32      "task_date_created" : "2025-01-01T00:00:00.000Z",
33      "task_priority" : 1,
34      "task_assignment_status" : "reserved",
35      "task_completed_reason" : "All reservations were completed",
36      "task_canceled_reason" : "hangup",
37      "reason" : "hangup",
38      "task_channel_sid" : "TC0000000000000000000000000000001",
39      "task_channel_unique_name" : "chat",
40      "reservation_sid" : "WR0000000000000000000000000000001",
41      "worker_sid" : "WK0000000000000000000000000000001",
42      "worker_name" : "Flex Task Assignment",
43      "worker_attributes" : "{}",
44      "worker_activity_sid" : "WA0000000000000000000000000000001",
45      "worker_activity_name" : "handling 2",
46      "worker_time_in_previous_activity" : 322,
47      "worker_time_in_previous_activity_ms" : 322859,
48      "worker_previous_activity_sid" : "WA0000000000000000000000000000002",
49      "worker_previous_activity_name" : "handling 1",
50      "workflow_sid" : "WW0000000000000000000000000000002",
51      "workflow_name" : "My workflow",
52      "task_queue_sid" : "WQ0000000000000000000000000000002",
53      "task_queue_name" : "My task queue",
54      "worker_channel_available" : 1,
55      "worker_channel_capacity" : 1,
56      "worker_channel_available_capacity" : 100.0,
57      "worker_channel_previous_capacity" : 6.0,
58      "worker_channel_task_count" : 0,
59      "workflow_filter_name" : "My workflow filter name",
60      "workflow_filter_expression" : "1==1",
61      "workflow_filter_target_expression" : "worker.channel.chat.assigned_tasks <= 1",
62      "workflow_filter_target_name" : "My workflow filter target name",
63      "previous_task_queue_sid" : "WQ0000000000000000000000000000001",
64      "previous_task_queue_name" : "My previous task queue name",
65      "previous_task_priority" : 3,
66      "target_changed_reason" : "skipped",
67      "task_re_evaluated_reason" : "reservation_timeout",
68      "task_queue_target_expression" : "allowed_channels HAS \"chat\"",
69      "task_transfer_sid" : "TT0000000000000000000000000000001",
70      "transfer_type" : "QUEUE",
71      "transfer_initiating_worker_sid" : "WK0000000000000000000000000000001",
72      "transfer_initiating_reservation_sid" : "WR0000000000000000000000000000001",
73      "transfer_to" : "WQ0000000000000000000000000000001",
74      "transfer_mode" : "COLD",
75      "transfer_started" : "2025-01-01T00:00:00.000Z",
76      "transfer_failed_reason" : "",
77      "transfer_status" : "complete",
78      "event_description" : "Reservation WR0000000000000000000000000000001 created",
79      "resource_type" : "reservation",
80      "resource_sid" : "WR0000000000000000000000000000001",
81      "task_routing_target" : "WK0000000000000000000000000000001",
82      "reservation_reason_code" : 45302,
83      "task_age_in_queue" : 31086,
84      "task_queue_entered_date" : "2025-01-01T00:00:00.000Z",
85      "task_version" : 4,
86      "reservation_version" : 0,
87      "task_virtual_start_time" : "2025-01-01T00:00:00.000Z",
88      "worker_channel_consumed_capacity" : 2,
89      "worker_version" : 4019,
90      "task_channel_name" : "My task channel name",
91      "task_channel_optimized_routing" : false,
92      "known_worker_sid" : "WK0000000000000000000000000000001",
93      "activity_sid" : "WA0000000000000000000000000000001",
94      "activity_name" : "My activity name",
95      "activity_available" : true,
96      "operating_unit_sid" : "OU0000000000000000000000000000001",
97      "operating_unit_friendly_name" : "My operating unit",
98      "operating_unit_date_created" : "2025-01-01T00:00:00.000Z",
99      "operating_unit_date_updated" : "2025-01-01T00:00:00.000Z",
100      "task_add_on_attributes" : "{}",
101      "task_timeout" : 86400,
102      "worker_available" : true,
103      "reservation_timeout" : 25,
104      "reservation_status" : "accepted"
105    }
106  }
107}

Versions

v4 (latest)

(information)

Info

v4 only contains updates to the schema metadata. In other words, there are no new fields between v3 and v4.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. Task virtual start time.
- integer worker_channel_consumed_capacity. Worker channel consumed capacity.
- integer worker_version. Worker version.
- string task_channel_name. Task channel name.
- boolean task_channel_optimized_routing. Task channel optimized routing flag.
- string known_worker_sid. Known worker SID.
- string activity_sid. Activity SID.
- string activity_name. Activity name.
- boolean activity_available. Activity available flag.
- string operating_unit_sid. Operating unit SID.
- string operating_unit_friendly_name. Operating unit friendly name.
- string operating_unit_date_created. Operating unit date created.
- string operating_unit_date_updated. Operating unit date updated.
- string task_add_on_attributes. Task add on attributes.
- integer task_timeout. Task time out.
- boolean worker_available. Worker availability flag.
- integer reservation_timeout. Reservation time out.
- string reservation_status. Reservation status.

The full specification for version 4 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- object task_attributes_json. [NEW] Task attributes json map.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. Task version.
- integer reservation_version. Reservation version.
- string task_virtual_start_time. [NEW] Task virtual start time.
- integer worker_channel_consumed_capacity. [NEW] Worker channel consumed capacity.
- integer worker_version. [NEW] Worker version.
- string task_channel_name. [NEW] Task channel name.
- boolean task_channel_optimized_routing. [NEW] Task channel optimized routing flag.
- string known_worker_sid. [NEW] Known worker SID.
- string activity_sid. [NEW] Activity SID.
- string activity_name. [NEW] Activity name.
- boolean activity_available. [NEW] Activity available flag.
- string operating_unit_sid. [NEW] Operating unit SID.
- string operating_unit_friendly_name. [NEW] Operating unit friendly name.
- string operating_unit_date_created. [NEW] Operating unit date created.
- string operating_unit_date_updated. [NEW] Operating unit date updated.
- string task_add_on_attributes. [NEW] Task add on attributes.
- integer task_timeout. [NEW] Task time out.
- boolean worker_available. [NEW] Worker availability flag.
- integer reservation_timeout. [NEW] Reservation time out.
- string reservation_status. [NEW] Reservation status.

The full specification for version 3 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity in seconds.
- integer worker_time_in_previous_activity_ms. [NEW] Worker time in previous activity in millis.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.
- integer task_version. [NEW] Task version.
- integer reservation_version. [NEW] Reservation version.

The full specification for version 2 is also available as a JSON schema.

string sid (required). SID.
string name (required). Name.
string account_sid (required). Account SID.
string account_friendly_name. Account friendly name.
string parent_account_sid. Parent account SID.
string parent_friendly_name. Parent account friendly name.
string timestamp (required). Timestamp.
string level (required). Level.
string group (required). Group.
string product_name (required). Product name.
string publisher (required). Publisher.
string publisher_metadata. Publisher metadata.
string payload_type (required). Payload type.
object payload (required). WSDEvent event payload definition.
- string sid (required). SID.
- string eventtype (required). Event type.
- string account_sid (required). Account SID.
- string timestamp (required). Timestamp.
- string workspace_sid (required). Workspace SID.
- string workspace_name (required). Worspace name.
- string task_sid. Task SID.
- string task_attributes. Task attributes.
- integer task_age. Task age.
- string task_date_created. Task date created.
- integer task_priority. Task Priority.
- string task_assignment_status. Task assignment status.
- string task_completed_reason. Task completed reason.
- string task_canceled_reason. Task canceled reason.
- string reason. Reason.
- string task_channel_sid. Task channel SID.
- string task_channel_unique_name. Task Channel unique name.
- string reservation_sid. Reservation SID.
- string worker_sid. Worker SID.
- string worker_name. Worker name.
- string worker_attributes. Worker attributes.
- string worker_activity_sid. Worker activity SID.
- string worker_activity_name. Worker activity name.
- integer worker_time_in_previous_activity. Worker time in previous activity.
- string worker_previous_activity_sid. Worker previous activity SID.
- string worker_previous_activity_name. Worker previous activity name.
- string workflow_sid. Workflow SID.
- string workflow_name. Workflow name.
- string task_queue_sid. Task queue SID.
- string task_queue_name. Task queue name.
- integer worker_channel_available. Worker channel available.
- integer worker_channel_capacity. Worker channel capacity.
- number worker_channel_available_capacity. Worker channel available capacity.
- number worker_channel_previous_capacity. Worker channel previous capacity.
- integer worker_channel_task_count. Worker channel task count.
- string workflow_filter_name. Workflow filter name.
- string workflow_filter_expression. Workflow filter expression.
- string workflow_filter_target_expression. Workflow filter target expression.
- string workflow_filter_target_name. Workflow filter name.
- string previous_task_queue_sid. Previous task queue SID.
- string previous_task_queue_name. Previous task queue name.
- integer previous_task_priority. Previous task priority.
- string target_changed_reason. Target changed reason.
- string task_re_evaluated_reason. Task reevaluated reason.
- string task_queue_target_expression. Task queue target expression.
- string task_transfer_sid. Task transfer SID.
- string transfer_type. Transfer type.
- string transfer_initiating_worker_sid. Transfer initiating worker SID.
- string transfer_initiating_reservation_sid. Transfer initiating reservation SID.
- string transfer_to. Transfer to.
- string transfer_mode. Transfer mode.
- string transfer_started. Transfer started.
- string transfer_failed_reason. Transfer failed reason.
- string transfer_status. Transfer status.
- string event_description. Event description.
- string resource_type. Resource type.
- string resource_sid. Resource SID.
- string task_routing_target. Task routing target.
- integer reservation_reason_code. Reservation reason code.
- integer task_age_in_queue. Task age in queue.
- string task_queue_entered_date. Task queue entered date.

The full specification for version 1 is also available as a JSON schema.