Getting started

To get started with the Flex SDK, you'll need to use a Flex account or add Flex to your Twilio account. If you're new to Flex, see the onboarding guide to get started or learn more about Flex pricing.

Develop a Flex SDK application

Use the following steps to develop a Flex SDK application. We'll use the vite framework here, but the Flex SDK also supports TypeScript and JavaScript.

Create a directory for the new Flex SDK application.
If you haven't already installed vite, run npm install -g vite.
Run npm create vite@latest.
Follow the wizard, and choose a vanilla project with TypeScript as the programming language.
Navigate into the newly created project folder and install the Flex SDK.
Run npm i @twilio/flex-sdk.
Run vite with npm run dev. This runs the vite application with the Flex SDK installed.

Initializing the SDK client

In order to use Flex in a code file, include the Flex SDK and initialize the client. While we recommend using SSO, you can also use an auth token like the example below:

1import { createClient } from "@twilio/flex-sdk";
2
3async function createFlexClient(tokenForWorker: string) {
4    const client = await createClient(tokenForWorker, {
5        logger: { level: "debug" }});
6    return client;
7}

Embed the Flex SDK into an existing application

To embed the Flex SDK into an existing application, navigate to the project directory and execute the following command:

npm i @twilio/flex-sdk

This adds the Flex SDK to the project, after which you can import and initialize clients.