Twilio/taskrouter

@keeb/twilio/taskrouterv2026.08.25.2· 16d agoMODELS

01README

Twilio taskrouter API models

02Release Notes

Updated: activity, event, task_channel, task_queue, task_queues_statistic, task_reservation, task, worker_channel, worker_reservation, worker, workflow, workspace

03Models26

activity.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the activity: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`
available?	boolean	no	Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a activity

fn get(id: string)

Get a activity

Argument	Type	Required	Description
id	string	yes	The sid of the activity

fn lookup(friendly_name?: string, available?: string, max_items?: number)

List activitys and record each as a data artifact (capped at 200 by default; writes a activity_lookup record with the coverage of the walk)

Argument	Type	Required	Description
friendly_name?	string	no	The `friendly_name` of the Activity resources to read.
available?	string	no	Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the activity_lookup record reports truncated: true.

fn update()

Update activity attributes

fn delete(id: string)

Delete the activity

Argument	Type	Required	Description
id	string	yes	The sid of the activity

fn sync()

Sync activity state from Twilio

Resources

state— Activity resource state

event.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the event: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a event

Argument	Type	Required	Description
id	string	yes	The sid of the event

fn lookup(end_date?: string, event_type?: string, minutes?: number, reservation_sid?: string, start_date?: string, task_queue_sid?: string, task_sid?: string, worker_sid?: string, workflow_sid?: string, task_channel?: string, sid?: string, max_items?: number)

List events and record each as a data artifact (capped at 200 by default; writes a event_lookup record with the coverage of the walk)

Argument	Type	Required	Description
end_date?	string	no	Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
event_type?	string	no	The type of Events to read. Returns only Events of the type specified.
minutes?	number	no	The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted.
reservation_sid?	string	no	The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.
start_date?	string	no	Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted.
task_queue_sid?	string	no	The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.
task_sid?	string	no	The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.
worker_sid?	string	no	The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.
workflow_sid?	string	no	The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.
task_channel?	string	no	The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.
sid?	string	no	The SID of the Event resource to read.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the event_lookup record reports truncated: true.

fn sync()

Sync event state from Twilio

Resources

state— Event resource state

task.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
attributes?	string	no	A JSON string with the attributes of the new task. This value is passed to the Workflow\'s `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ "task_type": "call", "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }`.
assignment_status?	enum	no	The current status of the Task's assignment. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`.
reason?	string	no	The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
priority?	number	no	The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).
task_channel?	string	no	When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.
virtual_start_time?	string	no	The virtual start time to assign the new task and override the default. When supplied, the new task will have this virtual start time. When not supplied, the new task will have the virtual start time equal to `date_created`. Value can't be in the future or before the year of 1900.
timeout?	number	no	The amount of time in seconds the new task can live before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.
workflow_sid?	string	no	The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.
routing_target?	string	no	A SID of a Worker, Queue, or Workflow to route a Task to
ignore_capacity?	string	no	A boolean that indicates if the Task should respect a Worker's capacity and availability during assignment. This field can only be used when the `RoutingTarget` field is set to a Worker SID. By setting `IgnoreCapacity` to a value of `true`, `1`, or `yes`, the Task will be routed to the Worker withou
task_queue_sid?	string	no	The SID of the TaskQueue in which the Task belongs
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a task

fn get(id: string)

Get a task

Argument	Type	Required	Description
id	string	yes	The sid of the task

fn lookup(priority?: number, assignment_status?: string, workflow_sid?: string, workflow_name?: string, task_queue_sid?: string, task_queue_name?: string, evaluate_task_attributes?: string, routing_target?: string, ordering?: string, has_addons?: boolean, max_items?: number)

List tasks and record each as a data artifact (capped at 200 by default; writes a task_lookup record with the coverage of the walk)

Argument	Type	Required	Description
priority?	number	no	The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
assignment_status?	string	no	The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
workflow_sid?	string	no	The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
workflow_name?	string	no	The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
task_queue_sid?	string	no	The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
task_queue_name?	string	no	The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
evaluate_task_attributes?	string	no	The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
routing_target?	string	no	A SID of a Worker, Queue, or Workflow to route a Task to
ordering?	string	no	How to order the returned Task resources. By default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `DateCreated`, `Priority`, or `VirtualStartTime` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` ret
has_addons?	boolean	no	Whether to read Tasks with Add-ons. If `true`, returns only Tasks with Add-ons. If `false`, returns only Tasks without Add-ons.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the task_lookup record reports truncated: true.

fn update()

Update task attributes

fn delete(id: string)

Delete the task

Argument	Type	Required	Description
id	string	yes	The sid of the task

fn sync()

Sync task state from Twilio

Resources

state— Task resource state

task_channel.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task channel: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
channel_optimized_routing?	boolean	no	Whether the Task Channel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
unique_name	string	yes	An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a task channel

fn get(id: string)

Get a task channel

Argument	Type	Required	Description
id	string	yes	The sid of the task channel

fn lookup(max_items?: number)

List task channels and record each as a data artifact (capped at 200 by default; writes a task_channel_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the task_channel_lookup record reports truncated: true.

fn update()

Update task channel attributes

fn delete(id: string)

Delete the task channel

Argument	Type	Required	Description
id	string	yes	The sid of the task channel

fn sync()

Sync task channel state from Twilio

Resources

state— Task channel resource state

task_queue.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queue: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
target_workers?	string	no	A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `\'"language" == "spanish"\'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information abo
reservation_activity_sid?	string	no	The SID of the Activity to assign Workers when a task is reserved for them.
assignment_activity_sid?	string	no	The SID of the Activity to assign Workers when a task is assigned to them.
max_reserved_workers?	number	no	The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.
task_order?	enum	no	How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or `FIFO` to assign the oldest Task. Default is FIFO. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a task queue

fn get(id: string)

Get a task queue

Argument	Type	Required	Description
id	string	yes	The sid of the task queue

fn lookup(friendly_name?: string, evaluate_worker_attributes?: string, worker_sid?: string, ordering?: string, max_items?: number)

List task queues and record each as a data artifact (capped at 200 by default; writes a task_queue_lookup record with the coverage of the walk)

Argument	Type	Required	Description
friendly_name?	string	no	The `friendly_name` of the TaskQueue resources to read.
evaluate_worker_attributes?	string	no	The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.
worker_sid?	string	no	The SID of the Worker with the TaskQueue resources to read.
ordering?	string	no	Sorting parameter for TaskQueues
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the task_queue_lookup record reports truncated: true.

fn update()

Update task queue attributes

fn delete(id: string)

Delete the task queue

Argument	Type	Required	Description
id	string	yes	The sid of the task queue

fn sync()

Sync task queue state from Twilio

Resources

state— Task queue resource state

task_queue_bulk_real_time_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queue bulk real time statistic: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a task queue bulk real time statistic

task_queue_cumulative_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queue cumulative statistic: workspace_sid
task_queue_sid	string	yes	Path scope for the task queue cumulative statistic: task_queue_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a task queue cumulative statistic

fn sync()

Sync task queue cumulative statistic state from Twilio

task_queue_real_time_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queue real time statistic: workspace_sid
task_queue_sid	string	yes	Path scope for the task queue real time statistic: task_queue_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a task queue real time statistic

fn sync()

Sync task queue real time statistic state from Twilio

task_queue_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queue statistic: workspace_sid
task_queue_sid	string	yes	Path scope for the task queue statistic: task_queue_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a task queue statistic

fn sync()

Sync task queue statistic state from Twilio

task_queues_statistic.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task queues statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn lookup(end_date?: string, friendly_name?: string, minutes?: number, start_date?: string, task_channel?: string, split_by_wait_time?: string, max_items?: number)

List task queues statistics and record each as a data artifact (capped at 200 by default; writes a task_queues_statistic_lookup record with the coverage of the walk)

Argument	Type	Required	Description
end_date?	string	no	Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
friendly_name?	string	no	The `friendly_name` of the TaskQueue statistics to read.
minutes?	number	no	Only calculate statistics since this many minutes in the past. The default is 15 minutes.
start_date?	string	no	Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
task_channel?	string	no	Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
split_by_wait_time?	string	no	A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the task_queues_statistic_lookup record reports truncated: true.

Resources

state— Task queues statistic resource state

task_reservation.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the task reservation: workspace_sid
task_sid	string	yes	Path scope for the task reservation: task_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
reservation_status?	enum	no	The current status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`.
worker_activity_sid?	string	no	The new worker activity SID if rejecting a reservation.
instruction?	string	no	The assignment instruction for reservation.
dequeue_post_work_activity_sid?	string	no	The SID of the Activity resource to start after executing a Dequeue instruction.
dequeue_from?	string	no	The Caller ID of the call to the worker when executing a Dequeue instruction.
dequeue_record?	string	no	Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
dequeue_timeout?	number	no	Timeout for call when executing a Dequeue instruction.
dequeue_to?	string	no	The Contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
dequeue_status_callback_url?	string	no	The Callback URL for completed call event when executing a Dequeue instruction.
call_from?	string	no	The Caller ID of the outbound call when executing a Call instruction.
call_record?	string	no	Whether to record both legs of a call when executing a Call instruction or which leg to record.
call_timeout?	number	no	Timeout for call when executing a Call instruction.
call_to?	string	no	The Contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
call_url?	string	no	TwiML URI executed on answering the worker's leg as a result of the Call instruction.
call_status_callback_url?	string	no	The URL to call for the completed call event when executing a Call instruction.
call_accept?	boolean	no	Whether to accept a reservation when executing a Call instruction.
redirect_call_sid?	string	no	The Call SID of the call parked in the queue when executing a Redirect instruction.
redirect_accept?	boolean	no	Whether the reservation should be accepted when executing a Redirect instruction.
redirect_url?	string	no	TwiML URI to redirect the call to when executing the Redirect instruction.
to?	string	no	The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
from?	string	no	The Caller ID of the call to the worker when executing a Conference instruction.
status_callback?	string	no	The URL we should call using the `status_callback_method` to send status information to your application.
status_callback_method?	enum	no	The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
status_callback_event?	array	no	The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.
timeout?	number	no	Timeout for call when executing a Conference instruction.
record?	boolean	no	Whether to record the participant and their conferences, including the time between conferences. The default is `false`.
muted?	boolean	no	Whether the agent is muted in the conference. The default is `false`.
beep?	string	no	Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
start_conference_on_enter?	boolean	no	Whether to start the conference when the participant joins, if it has not already started. The default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
end_conference_on_exit?	boolean	no	Whether to end the conference when the agent leaves.
wait_url?	string	no	The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
wait_method?	enum	no	The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
early_media?	boolean	no	Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.
max_participants?	number	no	The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
conference_status_callback?	string	no	The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
conference_status_callback_method?	enum	no	The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
conference_status_callback_event?	array	no	The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
conference_record?	string	no	Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
conference_trim?	string	no	How to trim the leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
recording_channels?	string	no	The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
recording_status_callback?	string	no	The URL that we should call using the `recording_status_callback_method` when the recording status changes.
recording_status_callback_method?	enum	no	The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
conference_recording_status_callback?	string	no	The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
conference_recording_status_callback_method?	enum	no	The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
region?	string	no	The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
sip_auth_username?	string	no	The SIP username used for authentication.
sip_auth_password?	string	no	The SIP password for authentication.
dequeue_status_callback_event?	array	no	The Call progress events sent via webhooks as a result of a Dequeue instruction.
post_work_activity_sid?	string	no	The new worker activity SID after executing a Conference instruction.
supervisor_mode?	enum	no
supervisor?	string	no	The Supervisor SID/URI when executing the Supervise instruction.
end_conference_on_customer_exit?	boolean	no	Whether to end the conference when the customer leaves.
beep_on_customer_entrance?	boolean	no	Whether to play a notification beep when the customer joins.
jitter_buffer_size?	string	no	The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a task reservation

Argument	Type	Required	Description
id	string	yes	The sid of the task reservation

fn lookup(reservation_status?: enum, worker_sid?: string, max_items?: number)

List task reservations and record each as a data artifact (capped at 200 by default; writes a task_reservation_lookup record with the coverage of the walk)

Argument	Type	Required	Description
reservation_status?	enum	no	Returns the list of reservations for a task with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, or `timeout`.
worker_sid?	string	no	The SID of the reserved Worker resource to read.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the task_reservation_lookup record reports truncated: true.

fn update()

Update task reservation attributes

fn sync()

Sync task reservation state from Twilio

Resources

state— Task reservation resource state

worker.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the worker: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
activity_sid?	string	no	The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.
attributes?	string	no	A valid JSON string that describes the new Worker. For example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
friendly_name	string	yes	A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.
reject_pending_reservations?	boolean	no	Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a worker

fn get(id: string)

Get a worker

Argument	Type	Required	Description
id	string	yes	The sid of the worker

fn lookup(activity_name?: string, activity_sid?: string, available?: string, friendly_name?: string, target_workers_expression?: string, task_queue_name?: string, task_queue_sid?: string, ordering?: string, max_items?: number)

List workers and record each as a data artifact (capped at 200 by default; writes a worker_lookup record with the coverage of the walk)

Argument	Type	Required	Description
activity_name?	string	no	The `activity_name` of the Worker resources to read.
activity_sid?	string	no	The `activity_sid` of the Worker resources to read.
available?	string	no	Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
friendly_name?	string	no	The `friendly_name` of the Worker resources to read.
target_workers_expression?	string	no	Filter by Workers that would match an expression. In addition to fields in the workers' attributes, the expression can include the following worker fields: `sid`, `friendly_name`, `activity_sid`, or `activity_name`
task_queue_name?	string	no	The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
task_queue_sid?	string	no	The SID of the TaskQueue that the Workers to read are eligible for.
ordering?	string	no	Sorting parameter for Workers
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the worker_lookup record reports truncated: true.

fn update()

Update worker attributes

fn delete(id: string)

Delete the worker

Argument	Type	Required	Description
id	string	yes	The sid of the worker

fn sync()

Sync worker state from Twilio

Resources

state— Worker resource state

worker_channel.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the worker channel: workspace_sid
worker_sid	string	yes	Path scope for the worker channel: worker_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
capacity?	number	no	The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.
available?	boolean	no	Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a worker channel

Argument	Type	Required	Description
id	string	yes	The sid of the worker channel

fn lookup(max_items?: number)

List worker channels and record each as a data artifact (capped at 200 by default; writes a worker_channel_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the worker_channel_lookup record reports truncated: true.

fn update()

Update worker channel attributes

fn sync()

Sync worker channel state from Twilio

Resources

state— Worker channel resource state

worker_reservation.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the worker reservation: workspace_sid
worker_sid	string	yes	Path scope for the worker reservation: worker_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
reservation_status?	enum	no	The current status of the reservation. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.
worker_activity_sid?	string	no	The new worker activity SID if rejecting a reservation.
instruction?	string	no	The assignment instruction for the reservation.
dequeue_post_work_activity_sid?	string	no	The SID of the Activity resource to start after executing a Dequeue instruction.
dequeue_from?	string	no	The caller ID of the call to the worker when executing a Dequeue instruction.
dequeue_record?	string	no	Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
dequeue_timeout?	number	no	The timeout for call when executing a Dequeue instruction.
dequeue_to?	string	no	The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
dequeue_status_callback_url?	string	no	The callback URL for completed call event when executing a Dequeue instruction.
call_from?	string	no	The Caller ID of the outbound call when executing a Call instruction.
call_record?	string	no	Whether to record both legs of a call when executing a Call instruction.
call_timeout?	number	no	The timeout for a call when executing a Call instruction.
call_to?	string	no	The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
call_url?	string	no	TwiML URI executed on answering the worker's leg as a result of the Call instruction.
call_status_callback_url?	string	no	The URL to call for the completed call event when executing a Call instruction.
call_accept?	boolean	no	Whether to accept a reservation when executing a Call instruction.
redirect_call_sid?	string	no	The Call SID of the call parked in the queue when executing a Redirect instruction.
redirect_accept?	boolean	no	Whether the reservation should be accepted when executing a Redirect instruction.
redirect_url?	string	no	TwiML URI to redirect the call to when executing the Redirect instruction.
to?	string	no	The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
from?	string	no	The caller ID of the call to the worker when executing a Conference instruction.
status_callback?	string	no	The URL we should call using the `status_callback_method` to send status information to your application.
status_callback_method?	enum	no	The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
status_callback_event?	array	no	The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.
timeout?	number	no	The timeout for a call when executing a Conference instruction.
record?	boolean	no	Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.
muted?	boolean	no	Whether the agent is muted in the conference. Defaults to `false`.
beep?	string	no	Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
start_conference_on_enter?	boolean	no	Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
end_conference_on_exit?	boolean	no	Whether to end the conference when the agent leaves.
wait_url?	string	no	The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
wait_method?	enum	no	The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
early_media?	boolean	no	Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.
max_participants?	number	no	The maximum number of participants allowed in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
conference_status_callback?	string	no	The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
conference_status_callback_method?	enum	no	The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
conference_status_callback_event?	array	no	The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
conference_record?	string	no	Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
conference_trim?	string	no	Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
recording_channels?	string	no	The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
recording_status_callback?	string	no	The URL that we should call using the `recording_status_callback_method` when the recording status changes.
recording_status_callback_method?	enum	no	The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
conference_recording_status_callback?	string	no	The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
conference_recording_status_callback_method?	enum	no	The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
region?	string	no	The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
sip_auth_username?	string	no	The SIP username used for authentication.
sip_auth_password?	string	no	The SIP password for authentication.
dequeue_status_callback_event?	array	no	The call progress events sent via webhooks as a result of a Dequeue instruction.
post_work_activity_sid?	string	no	The new worker activity SID after executing a Conference instruction.
end_conference_on_customer_exit?	boolean	no	Whether to end the conference when the customer leaves.
beep_on_customer_entrance?	boolean	no	Whether to play a notification beep when the customer joins.
jitter_buffer_size?	string	no	The jitter buffer size for conference. Can be: `small`, `medium`, `large`, `off`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a worker reservation

Argument	Type	Required	Description
id	string	yes	The sid of the worker reservation

fn lookup(reservation_status?: enum, max_items?: number)

List worker reservations and record each as a data artifact (capped at 200 by default; writes a worker_reservation_lookup record with the coverage of the walk)

Argument	Type	Required	Description
reservation_status?	enum	no	Returns the list of reservations for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the worker_reservation_lookup record reports truncated: true.

fn update()

Update worker reservation attributes

fn sync()

Sync worker reservation state from Twilio

Resources

state— Worker reservation resource state

worker_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the worker statistic: workspace_sid
worker_sid	string	yes	Path scope for the worker statistic: worker_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a worker statistic

fn sync()

Sync worker statistic state from Twilio

workers_cumulative_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workers cumulative statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workers cumulative statistic

fn sync()

Sync workers cumulative statistic state from Twilio

workers_real_time_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workers real time statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workers real time statistic

fn sync()

Sync workers real time statistic state from Twilio

workers_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workers statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workers statistic

fn sync()

Sync workers statistic state from Twilio

workflow.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workflow: workspace_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
assignment_callback_url?	string	no	The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.
fallback_assignment_callback_url?	string	no	The URL that we should call when a call to the `assignment_callback_url` fails.
configuration	string	yes	A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.
task_reservation_timeout?	number	no	How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.
re_evaluate_tasks?	string	no	Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a workflow

fn get(id: string)

Get a workflow

Argument	Type	Required	Description
id	string	yes	The sid of the workflow

fn lookup(friendly_name?: string, max_items?: number)

List workflows and record each as a data artifact (capped at 200 by default; writes a workflow_lookup record with the coverage of the walk)

Argument	Type	Required	Description
friendly_name?	string	no	The `friendly_name` of the Workflow resources to read.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the workflow_lookup record reports truncated: true.

fn update()

Update workflow attributes

fn delete(id: string)

Delete the workflow

Argument	Type	Required	Description
id	string	yes	The sid of the workflow

fn sync()

Sync workflow state from Twilio

Resources

state— Workflow resource state

workflow_cumulative_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workflow cumulative statistic: workspace_sid
workflow_sid	string	yes	Path scope for the workflow cumulative statistic: workflow_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workflow cumulative statistic

fn sync()

Sync workflow cumulative statistic state from Twilio

workflow_real_time_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workflow real time statistic: workspace_sid
workflow_sid	string	yes	Path scope for the workflow real time statistic: workflow_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workflow real time statistic

fn sync()

Sync workflow real time statistic state from Twilio

workflow_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workflow statistic: workspace_sid
workflow_sid	string	yes	Path scope for the workflow statistic: workflow_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workflow statistic

fn sync()

Sync workflow statistic state from Twilio

workspace.tsv2026.08.25.2

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
default_activity_sid?	string	no	The SID of the Activity that will be used when new Workers are created in the Workspace.
event_callback_url?	string	no	The URL we should call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information. This parameter supports Twilio's [Webhooks (HTTP callbac
events_filter?	string	no	The list of Workspace events for which to call event_callback_url. For example, if `EventsFilter=task.created, task.canceled, worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.
friendly_name	string	yes	A descriptive string that you create to describe the Workspace resource. It can be up to 64 characters long. For example: `Customer Support` or `2014 Election Campaign`.
multi_task_enabled?	boolean	no	Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. However, all workspaces should be created as multi-tasking. The default is `true`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive p
timeout_activity_sid?	string	no	The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.
prioritize_queue_order?	enum	no	The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
template?	string	no	An available template name. Can be: `NONE` or `FIFO` and the default is `NONE`. Pre-configures the Workspace with the Workflow and Activities specified in the template. `NONE` will create a Workspace with only a set of default activities. `FIFO` will configure TaskRouter with a set of default activi
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a workspace

fn get(id: string)

Get a workspace

Argument	Type	Required	Description
id	string	yes	The sid of the workspace

fn lookup(friendly_name?: string, max_items?: number)

List workspaces and record each as a data artifact (capped at 200 by default; writes a workspace_lookup record with the coverage of the walk)

Argument	Type	Required	Description
friendly_name?	string	no	The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the workspace_lookup record reports truncated: true.

fn update()

Update workspace attributes

fn delete(id: string)

Delete the workspace

Argument	Type	Required	Description
id	string	yes	The sid of the workspace

fn sync()

Sync workspace state from Twilio

Resources

state— Workspace resource state

workspace_cumulative_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workspace cumulative statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workspace cumulative statistic

fn sync()

Sync workspace cumulative statistic state from Twilio

workspace_real_time_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workspace real time statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workspace real time statistic

fn sync()

Sync workspace real time statistic state from Twilio

workspace_statistic.tsv2026.08.25.1

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
workspace_sid	string	yes	Path scope for the workspace statistic: workspace_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a workspace statistic

fn sync()

Sync workspace statistic state from Twilio

04Stats

85 / 100

Downloads

Archive size

116.0 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository0/2missing

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #taskrouter #communications #saas