Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Twilio Flex Quickstart: Getting Started with Flex Plugin Development


In just a few minutes, you can extend and modify your Twilio Flex call center instance using the JavaScript React framework.(link takes you to an external page)

During this Quickstart, you'll use React to customize your Flex instance by integrating a search engine into the Flex CRM container. This Quickstart only involves cutting/pasting some React code. If you want to learn more, check out the official React Docs(link takes you to an external page).

At the end of this Quickstart, you'll know how to develop a Flex plugin, test it locally, and upload your changes to a Twilio-hosted Flex instance. Once you've seen basic changes you can make with React, you can start to make more extensive modifications to your contact center instance.

In this Quickstart, we will:

  1. Create a new Flex hosted instance
  2. Install the Flex Plugins CLI
  3. Walk through the plugin creation steps locally
  4. Develop your plugins locally
  5. Deploy your plugins and enable your plugin on your Flex application
  6. Verify your changes in the Twilio hosted call center instance

Prefer other styles of learning? See our collection of Flex video tutorials and demos(link takes you to an external page).


Create a hosted Twilio Flex instance

create-a-hosted-twilio-flex-instance page anchor

Before you start working on plugins for Flex, you'll need a cloud call center instance to apply them on. Let's create a new Flex instance now.

(information)

Info

If you already have a Twilio Flex instance you'd like to customize, feel free to skip ahead to the plugin prerequisites.

Sign up for (or sign in to) Twilio and create a Flex Project

sign-up-for-or-sign-in-to-twilio-and-create-a-flex-project page anchor

Before you can work with Flex, you'll need to sign up for a Twilio account(link takes you to an external page) or sign into your existing account.

  1. Once in the console, navigate to the Flex product(link takes you to an external page):

    Console_Flex.npm -v in your terminal to check)
  2. A Node.js long-term-support (LTS) version(link takes you to an external page) installed (type node -v in your terminal to check):

    • React v16 recommended for Flex UI 1.x
    • React v17 recommended for Flex UI 2.x
  3. Twilio CLI installed on your machine. We recommend installing the latest version of the Twilio CLI.

Login to your Twilio Flex application via Twilio CLI

login-to-your-twilio-flex-application-via-twilio-cli page anchor

In order to run the CLI commands, on your Flex application run the following command:


_10
twilio login

You will be prompted for your Account SID and Auth Token, both of which you can find in the Twilio Console Dashboard(link takes you to an external page).

AccountSID.Rate this page:

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.