Twilio/flex

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

01README

Twilio flex API models

02Release Notes

Updated: assessment, channel, configured_plugin, flex_flow, insights_assessments_comment, insights_conversation, insights_questionnaire, insights_questionnaires_category, insights_questionnaires_question, insights_segment, interaction_channel_invite, interaction_channel_participant, interaction_channel, plugin_configuration, plugin_release, plugin_version, plugin, web_channel_v1

03Models31

@keeb/twilio/flex/assessmentv2026.08.25.2assessment.ts

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)
offset	number	yes	The offset of the conversation.
answer_text	string	yes	The answer text selected by user
answer_id	string	yes	The id of the answer selected by user
category_sid	string	yes	The SID of the category
category_name	string	yes	The name of the category
segment_id	string	yes	Segment Id of the conversation
agent_id	string	yes	The id of the Agent
metric_id	string	yes	The question SID selected for assessment
metric_name	string	yes	The question name of the assessment
questionnaire_sid	string	yes	Questionnaire SID of the associated question
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 assessment

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

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

Argument	Type	Required	Description
segment_id?	string	no	The id of the segment.
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 assessment_lookup record reports truncated: true.

fn update()

Update assessment attributes

Resources

state(infinite)— Assessment resource state

assessment_lookup(infinite)— Assessment lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/channelv2026.08.25.2channel.ts

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)
flex_flow_sid	string	yes	The SID of the Flex Flow.
identity	string	yes	The `identity` value that uniquely identifies the new resource's chat User.
chat_user_friendly_name	string	yes	The chat participant's friendly name.
chat_friendly_name	string	yes	The chat channel's friendly name.
target?	string	no	The Target Contact Identity, for example the phone number of an SMS.
chat_unique_name?	string	no	The chat channel's unique name.
pre_engagement_data?	string	no	The pre-engagement data.
task_sid?	string	no	The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`
task_attributes?	string	no	The Task attributes to be added for the TaskRouter Task.
long_lived?	boolean	no	Whether to create the channel as long-lived.
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 channel

fn get(id: string)

Get a channel

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

fn lookup(max_items?: number)

List channels and record each as a data artifact (capped at 200 by default; writes a 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 channel_lookup record reports truncated: true.

fn delete(id: string)

Delete the channel

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

fn sync()

Sync channel state from Twilio

Resources

state(infinite)— Channel resource state

channel_lookup(infinite)— Channel lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/configurationv2026.08.25.1configuration.ts

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	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 configuration

fn update()

Update configuration attributes

fn sync()

Sync configuration state from Twilio

Resources

state(infinite)— Configuration resource state

@keeb/twilio/flex/configured-pluginv2026.08.25.2configured_plugin.ts

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.
configuration_sid	string	yes	Path scope for the configured plugin: configuration_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 configured plugin

Argument	Type	Required	Description
id	string	yes	The sid of the configured plugin

fn lookup(max_items?: number)

List configured plugins and record each as a data artifact (capped at 200 by default; writes a configured_plugin_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 configured_plugin_lookup record reports truncated: true.

fn sync()

Sync configured plugin state from Twilio

Resources

state(infinite)— Configured plugin resource state

configured_plugin_lookup(infinite)— Configured plugin lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/flex-flowv2026.08.25.2flex_flow.ts

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)
friendly_name	string	yes	A descriptive string that you create to describe the Flex Flow resource.
chat_service_sid	string	yes	The SID of the chat service.
channel_type	enum	yes
contact_identity?	string	no	The channel contact's Identity.
enabled?	boolean	no	Whether the new Flex Flow is enabled.
integration_type?	enum	no	The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`.
integration_flow_sid?	string	no	The SID of the Studio Flow. Required when `integrationType` is `studio`.
integration_url?	string	no	The URL of the external webhook. Required when `integrationType` is `external`.
integration_workspace_sid?	string	no	The Workspace SID for a new Task. Required when `integrationType` is `task`.
integration_workflow_sid?	string	no	The Workflow SID for a new Task. Required when `integrationType` is `task`.
integration_channel?	string	no	The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`.
integration_timeout?	number	no	The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise.
integration_priority?	number	no	The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise.
integration_creation_on_message?	boolean	no	In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only appl
long_lived?	boolean	no	When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`.
janitor_enabled?	boolean	no	When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`.
integration_retry_count?	number	no	The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise.
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 flex flow

fn get(id: string)

Get a flex flow

Argument	Type	Required	Description
id	string	yes	The sid of the flex flow

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

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

Argument	Type	Required	Description
friendly_name?	string	no	The `friendly_name` of the Flex Flow 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 flex_flow_lookup record reports truncated: true.

fn update()

Update flex flow attributes

fn delete(id: string)

Delete the flex flow

Argument	Type	Required	Description
id	string	yes	The sid of the flex flow

fn sync()

Sync flex flow state from Twilio

Resources

state(infinite)— Flex flow resource state

flex_flow_lookup(infinite)— Flex flow lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/flex-userv2026.08.25.1flex_user.ts

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.
instance_sid	string	yes	Path scope for the flex user: instance_sid
flex_user_sid	string	yes	Path scope for the flex user: flex_user_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
email?	string	no	Email of the User.
user_sid?	string	no	The unique SID identifier of the Twilio Unified User.
locale?	string	no	The locale preference of the user.
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 flex user

Argument	Type	Required	Description
id	string	yes	The sid of the flex user

fn update()

Update flex user attributes

fn sync()

Sync flex user state from Twilio

Resources

state(infinite)— Flex user resource state

@keeb/twilio/flex/insights-assessments-commentv2026.08.25.2insights_assessments_comment.ts

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)
category_id	string	yes	The ID of the category
category_name	string	yes	The name of the category
comment	string	yes	The Assessment comment.
segment_id	string	yes	The id of the segment.
agent_id	string	yes	The id of the agent.
offset	number	yes	The offset
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 insights assessments comment

fn lookup(segment_id?: string, agent_id?: string, max_items?: number)

List insights assessments comments and record each as a data artifact (capped at 200 by default; writes a insights_assessments_comment_lookup record with the coverage of the walk)

Argument	Type	Required	Description
segment_id?	string	no	The id of the segment.
agent_id?	string	no	The id of the agent.
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 insights_assessments_comment_lookup record reports truncated: true.

Resources

state(infinite)— Insights assessments comment resource state

insights_assessments_comment_lookup(infinite)— Insights assessments comment lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-conversationv2026.08.25.2insights_conversation.ts

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	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(segment_id?: string, max_items?: number)

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

Argument	Type	Required	Description
segment_id?	string	no	Unique Id of the segment for which conversation details needs to be fetched
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 insights_conversation_lookup record reports truncated: true.

Resources

state(infinite)— Insights conversation resource state

insights_conversation_lookup(infinite)— Insights conversation lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-questionnairev2026.08.25.2insights_questionnaire.ts

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.
active?	boolean	no	The flag to enable or disable questionnaire
name	string	yes	The name of this questionnaire
description?	string	no	The description of this questionnaire
question_sids?	array	no	The list of questions sids under a questionnaire
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 insights questionnaire

fn get(id: string)

Get a insights questionnaire

Argument	Type	Required	Description
id	string	yes	The sid of the insights questionnaire

fn lookup(include_inactive?: boolean, max_items?: number)

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

Argument	Type	Required	Description
include_inactive?	boolean	no	Flag indicating whether to include inactive questionnaires or not
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 insights_questionnaire_lookup record reports truncated: true.

fn update()

Update insights questionnaire attributes

fn delete(id: string)

Delete the insights questionnaire

Argument	Type	Required	Description
id	string	yes	The sid of the insights questionnaire

fn sync()

Sync insights questionnaire state from Twilio

Resources

state(infinite)— Insights questionnaire resource state

insights_questionnaire_lookup(infinite)— Insights questionnaire lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-questionnaires-categoryv2026.08.25.2insights_questionnaires_category.ts

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	The name of this category.
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 insights questionnaires category

fn lookup(max_items?: number)

List insights questionnaires categorys and record each as a data artifact (capped at 200 by default; writes a insights_questionnaires_category_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 insights_questionnaires_category_lookup record reports truncated: true.

fn update()

Update insights questionnaires category attributes

fn delete(id: string)

Delete the insights questionnaires category

Argument	Type	Required	Description
id	string	yes	The sid of the insights questionnaires category

Resources

state(infinite)— Insights questionnaires category resource state

insights_questionnaires_category_lookup(infinite)— Insights questionnaires category lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-questionnaires-questionv2026.08.25.2insights_questionnaires_question.ts

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)
allow_na	boolean	yes	The flag to enable for disable NA for answer.
category_sid	string	yes	The SID of the category
question	string	yes	The question.
description?	string	no	The description for the question.
answer_set_id	string	yes	The answer_set for the question.
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 insights questionnaires question

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

List insights questionnaires questions and record each as a data artifact (capped at 200 by default; writes a insights_questionnaires_question_lookup record with the coverage of the walk)

Argument	Type	Required	Description
category_sid?	string	no	The list of category SIDs
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 insights_questionnaires_question_lookup record reports truncated: true.

fn update()

Update insights questionnaires question attributes

fn delete(id: string)

Delete the insights questionnaires question

Argument	Type	Required	Description
id	string	yes	The sid of the insights questionnaires question

Resources

state(infinite)— Insights questionnaires question resource state

insights_questionnaires_question_lookup(infinite)— Insights questionnaires question lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-segmentv2026.08.25.2insights_segment.ts

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	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(segment_id?: string, reservation_id?: string, max_items?: number)

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

Argument	Type	Required	Description
segment_id?	string	no	To unique id of the segment
reservation_id?	string	no	The list of reservation Ids
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 insights_segment_lookup record reports truncated: true.

Resources

state(infinite)— Insights segment resource state

insights_segment_lookup(infinite)— Insights segment lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/insights-sessionv2026.08.25.1insights_session.ts

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	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 update()

Update insights session attributes

Resources

state(infinite)— Insights session resource state

@keeb/twilio/flex/insights-settings-answer-setv2026.08.25.1insights_settings_answer_set.ts

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	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 insights settings answer set

fn sync()

Sync insights settings answer set state from Twilio

Resources

state(infinite)— Insights settings answer set resource state

@keeb/twilio/flex/insights-settings-commentv2026.08.25.1insights_settings_comment.ts

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	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 insights settings comment

fn sync()

Sync insights settings comment state from Twilio

Resources

state(infinite)— Insights settings comment resource state

@keeb/twilio/flex/insights-user-rolev2026.08.25.1insights_user_role.ts

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	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 insights user role

fn sync()

Sync insights user role state from Twilio

Resources

state(infinite)— Insights user role resource state

@keeb/twilio/flex/interactionv2026.08.25.1interaction.ts

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)
webhook_ttid?	string	no	The unique identifier for Interaction level webhook
channel	string	yes	The Interaction's channel.
routing?	string	no	The Interaction's routing logic.
interaction_context_sid?	string	no	The Interaction context sid is used for adding a context lookup sid
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 interaction

fn get(id: string)

Get a interaction

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

fn update()

Update interaction attributes

fn sync()

Sync interaction state from Twilio

Resources

state(infinite)— Interaction resource state

@keeb/twilio/flex/interaction-channelv2026.08.25.2interaction_channel.ts

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.
interaction_sid	string	yes	Path scope for the interaction channel: interaction_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
status	enum	yes
routing?	string	no	It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`.
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 interaction channel

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

fn lookup(max_items?: number)

List interaction channels and record each as a data artifact (capped at 200 by default; writes a interaction_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 interaction_channel_lookup record reports truncated: true.

fn update()

Update interaction channel attributes

fn sync()

Sync interaction channel state from Twilio

Resources

state(infinite)— Interaction channel resource state

interaction_channel_lookup(infinite)— Interaction channel lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/interaction-channel-invitev2026.08.25.2interaction_channel_invite.ts

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.
interaction_sid	string	yes	Path scope for the interaction channel invite: interaction_sid
channel_sid	string	yes	Path scope for the interaction channel invite: channel_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
routing	string	yes	The Interaction's routing logic.
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 interaction channel invite

fn lookup(max_items?: number)

List interaction channel invites and record each as a data artifact (capped at 200 by default; writes a interaction_channel_invite_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 interaction_channel_invite_lookup record reports truncated: true.

Resources

state(infinite)— Interaction channel invite resource state

interaction_channel_invite_lookup(infinite)— Interaction channel invite lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/interaction-channel-participantv2026.08.25.2interaction_channel_participant.ts

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.
interaction_sid	string	yes	Path scope for the interaction channel participant: interaction_sid
channel_sid	string	yes	Path scope for the interaction channel participant: channel_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no
type	enum	yes	Participant type. Can be: `agent`, `customer`, `supervisor`, `external`, `unknown`
media_properties	string	yes	JSON representing the Media Properties for the new Participant.
routing_properties?	string	no	Object representing the Routing Properties for the new Participant.
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 interaction channel participant

fn lookup(max_items?: number)

List interaction channel participants and record each as a data artifact (capped at 200 by default; writes a interaction_channel_participant_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 interaction_channel_participant_lookup record reports truncated: true.

fn update()

Update interaction channel participant attributes

Resources

state(infinite)— Interaction channel participant resource state

interaction_channel_participant_lookup(infinite)— Interaction channel participant lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/interaction-transferv2026.08.25.1interaction_transfer.ts

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.
interaction_sid	string	yes	Path scope for the interaction transfer: interaction_sid
channel_sid	string	yes	Path scope for the interaction transfer: channel_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 interaction transfer

fn get(id: string)

Get a interaction transfer

Argument	Type	Required	Description
id	string	yes	The sid of the interaction transfer

fn update()

Update interaction transfer attributes

fn sync()

Sync interaction transfer state from Twilio

Resources

state(infinite)— Interaction transfer resource state

@keeb/twilio/flex/pluginv2026.08.25.2plugin.ts

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)
friendly_name?	string	no	The Flex Plugin's friendly name.
description?	string	no	A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
unique_name	string	yes	The Flex Plugin's unique name.
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 plugin

fn get(id: string)

Get a plugin

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

fn lookup(max_items?: number)

List plugins and record each as a data artifact (capped at 200 by default; writes a plugin_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 plugin_lookup record reports truncated: true.

fn update()

Update plugin attributes

fn sync()

Sync plugin state from Twilio

Resources

state(infinite)— Plugin resource state

plugin_lookup(infinite)— Plugin lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/plugin-archivev2026.08.25.1plugin_archive.ts

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.
sid	string	yes	Path scope for the plugin archive: 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 update()

Update plugin archive attributes

Resources

state(infinite)— Plugin archive resource state

@keeb/twilio/flex/plugin-configurationv2026.08.25.2plugin_configuration.ts

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	The Flex Plugin Configuration's name.
plugins?	array	no	A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version.
description?	string	no	The Flex Plugin Configuration's description.
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 plugin configuration

fn get(id: string)

Get a plugin configuration

Argument	Type	Required	Description
id	string	yes	The sid of the plugin configuration

fn lookup(max_items?: number)

List plugin configurations and record each as a data artifact (capped at 200 by default; writes a plugin_configuration_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 plugin_configuration_lookup record reports truncated: true.

fn sync()

Sync plugin configuration state from Twilio

Resources

state(infinite)— Plugin configuration resource state

plugin_configuration_lookup(infinite)— Plugin configuration lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/plugin-configuration-archivev2026.08.25.1plugin_configuration_archive.ts

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.
sid	string	yes	Path scope for the plugin configuration archive: 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 update()

Update plugin configuration archive attributes

Resources

state(infinite)— Plugin configuration archive resource state

@keeb/twilio/flex/plugin-releasev2026.08.25.2plugin_release.ts

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)
configuration_id	string	yes	The SID or the Version of the Flex Plugin Configuration to release.
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 plugin release

fn get(id: string)

Get a plugin release

Argument	Type	Required	Description
id	string	yes	The sid of the plugin release

fn lookup(max_items?: number)

List plugin releases and record each as a data artifact (capped at 200 by default; writes a plugin_release_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 plugin_release_lookup record reports truncated: true.

fn sync()

Sync plugin release state from Twilio

Resources

state(infinite)— Plugin release resource state

plugin_release_lookup(infinite)— Plugin release lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/plugin-versionv2026.08.25.2plugin_version.ts

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.
plugin_sid	string	yes	Path scope for the plugin version: plugin_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
version	string	yes	The Flex Plugin Version's version.
plugin_url	string	yes	The URL of the Flex Plugin Version bundle
changelog?	string	no	The changelog of the Flex Plugin Version.
private?	boolean	no	Whether this Flex Plugin Version requires authorization.
cli_version?	string	no	The version of Flex Plugins CLI used to create this plugin
validate_status?	string	no	The validation status of the plugin, indicating whether it has been validated
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 plugin version

fn get(id: string)

Get a plugin version

Argument	Type	Required	Description
id	string	yes	The sid of the plugin version

fn lookup(max_items?: number)

List plugin versions and record each as a data artifact (capped at 200 by default; writes a plugin_version_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 plugin_version_lookup record reports truncated: true.

fn sync()

Sync plugin version state from Twilio

Resources

state(infinite)— Plugin version resource state

plugin_version_lookup(infinite)— Plugin version lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/flex/plugin-version-archivev2026.08.25.1plugin_version_archive.ts

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.
plugin_sid	string	yes	Path scope for the plugin version archive: plugin_sid
sid	string	yes	Path scope for the plugin version archive: 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 update()

Update plugin version archive attributes

Resources

state(infinite)— Plugin version archive resource state

@keeb/twilio/flex/provisioning-statusv2026.08.25.1provisioning_status.ts

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	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 provisioning status

fn sync()

Sync provisioning status state from Twilio

Resources

state(infinite)— Provisioning status resource state

@keeb/twilio/flex/web-channelv2026.08.25.1web_channel.ts

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)
address_sid	string	yes	The SID of the Conversations Address. See [Address Configuration Resource](https://www.twilio.com/docs/conversations/api/address-configuration-resource) for configuration details. When a conversation is created on the Flex backend, the callback URL will be set to the corresponding Studio Flow SID or
chat_friendly_name?	string	no	The Conversation's friendly name. See the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) for an example.
customer_friendly_name?	string	no	The Conversation participant's friendly name. See the [Conversation Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) for an example.
pre_engagement_data?	string	no	The pre-engagement data.
identity?	string	no	The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example.
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 web channel

Resources

state(infinite)— Web channel resource state

@keeb/twilio/flex/web-channel-v1v2026.08.25.2web_channel_v1.ts

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)
chat_status?	enum	no
post_engagement_data?	string	no	The post-engagement data.
flex_flow_sid	string	yes	The SID of the Flex Flow.
identity	string	yes	The chat identity.
customer_friendly_name	string	yes	The chat participant's friendly name.
chat_friendly_name	string	yes	The chat channel's friendly name.
chat_unique_name?	string	no	The chat channel's unique name.
pre_engagement_data?	string	no	The pre-engagement data.
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 web channel v1

fn get(id: string)

Get a web channel v1

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

fn lookup(max_items?: number)

List web channel v1s and record each as a data artifact (capped at 200 by default; writes a web_channel_v1_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 web_channel_v1_lookup record reports truncated: true.

fn update()

Update web channel v1 attributes

fn delete(id: string)

Delete the web channel v1

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

fn sync()

Sync web channel v1 state from Twilio

Resources

state(infinite)— Web channel v1 resource state

web_channel_v1_lookup(infinite)— Web channel v1 lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

98.2 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 #flex #communications #saas