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.
  2. Now, select 'Create My Flex Account':

    Create-flex.
  3. Give your new project a name and verify a phone number
  4. Flex will run through an initialization process to get your new account configured

And that's all you need for now. Let it go through its setup, and you'll get a vanilla hosted Flex instance for us to modify.


Prerequisites for developing a Flex Plugin

prerequisites-for-developing-a-flex-plugin page anchor

Before you can start creating Flex plugins with React, you'll need a few things in place.

  • A Twilio account with a Flex environment provisioned (the previous section)
  • npm version 6.0.0 installed (type npm -v in your terminal to check)
  • 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
  • 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.

Once you have logged in succesfully, all the subsequent CLI commands will use the Flex account you logged in with.

Learn more about using multiple accounts by visiting the Twilio CLI General Usage Guide.


Set up a Flex environment with Flex Plugins CLI

set-up-a-flex-environment-with-flex-plugins-cli page anchor

Once you have NPM and Node of the proper version, you're ready to develop your Flex plugin. The Flex Plugins CLIis the easiest way to start building Flex plugins. It gives you a clean environment in which to develop your Flex plugin as well as tools to build and deploy your plugin. With the Flex Plugins CLI, you know that your Flex plugins will be modular - that is, Plugin A won't interfere with the behavior of Plugin B.

Follow the steps in Plugins CLI documentation for installation.


Set up a sample Flex plugin

set-up-a-sample-flex-plugin page anchor

In your terminal, run the following commands to set up a sample Flex plugin:

Flex UI 2.xFlex UI 1.x

_10
# Now we can start with a template plugin for Flex 2.0 with the create command
_10
twilio flex:plugins:create plugin-sample --install
_10
_10
# Or if you prefer a typescript project run
_10
twilio flex:plugins:create plugin-sample --install --typescript

Once you have created your plugin development environment, you can navigate into your plugin's code directory and start Flex:


_10
cd plugin-sample
_10
twilio flex:plugins:start

A Flex instance should now be running on localhost:3000. You might need to login to your Flex instance by clicking on the "Login with Twilio" link and logging in with your Twilio credentials.

Login with Twilio.

Open your favorite text editor and change the directory to the plugin folder we just built. At the moment, our plugin just adds a black bar to the top of the task list - but we're going to configure the CRM to be an instance of the Bing search engine instead.

Flex UI 2.xFlex UI 1.x
  1. Navigate into the folder created for plugin-sample (or the name you picked)
  2. Open the file src/SamplePlugin.js
  3. Replace the code in that file with the following


    _26
    import React from "react"
    _26
    import { FlexPlugin } from "@twilio/flex-plugin"
    _26
    _26
    import CustomTaskList from "./components/CustomTaskList/CustomTaskList"
    _26
    _26
    const PLUGIN_NAME = "SamplePlugin"
    _26
    _26
    export default class SamplePlugin extends FlexPlugin {
    _26
    constructor() {
    _26
    super(PLUGIN_NAME)
    _26
    }
    _26
    _26
    /**
    _26
    * This code is run when your plugin is being started
    _26
    * Use this to modify any UI components or attach to the actions framework
    _26
    *
    _26
    * @param flex { typeof import('@twilio/flex-ui') }
    _26
    */
    _26
    async init(flex, manager) {
    _26
    flex.CRMContainer.defaultProps.uriCallback = (task) => {
    _26
    return task
    _26
    ? `https://www.bing.com/search?q=${task.attributes.name}`
    _26
    : "https://www.bing.com"
    _26
    }
    _26
    }
    _26
    }

  4. Save it
  5. Your browser will automatically reload. Now your instance should look like the following:

    FlexCRMBingHomePage.
  6. (Optional) Text in and see if there are any Bing results for your phone number!

    You might notice that all we changed was a couple of lines of code:


    _10
    const options = { sortOrder: -1 };
    _10
    flex.AgentDesktopView.Panel1.Content.add(<CustomTaskList key="SamplePlugin-component" />, options);

    is replaced by


    _10
    flex.CRMContainer.defaultProps.uriCallback = (task) => {
    _10
    return task
    _10
    ? `https://www.bing.com/search?q=${task.attributes.name}`
    _10
    : "https://www.bing.com"
    _10
    }

    This tells Flex to target the CRMContainer (instead of the CutomTaskList). Instead of adding a component to the CustomTaskList, we update the URI that the CRMContainer uses as a default prop to render its contents. In this case, we also add a bit of logic to make the container dynamic. We check to see if there's an active task. If there is an active task, we search for the task's name attribute, otherwise, we just show the https://bing.com landing page.

    Flex allows you to add, remove, and replace components so that you can tailor your contact center to your business needs. As you build more complex plugins, your workflow will remain similar. When you save files, your environment will reload and you can see the changes locally. To use the Twilio Paste UX library in your plugins, please see Use Twilio Paste with a Flex Plugin.

    Next up, you'll build the plugin and deploy it to your hosted instance.


You need to deploy your plugin so that your plugin can be enabled on your live Flex Application. The Flex Plugins CLI uses the Functions & Assets API to upload your plugin directly from your CLI.

  1. In your terminal, within the plugin-sample directory we created, run


    _10
    twilio flex:plugins:deploy --major --changelog "Adding Bing as search engine" --description "First Plugin on Flex"

  2. Inorder to enable your plugin, run


    _10
    twilio flex:plugins:release --name "First Plugin Release" --description "Enabling Plugin Sample" --plugin plugin-sample@1.0.0

  3. Reload your Flex Agent Dashboard(link takes you to an external page) . You should now see the new Bing-powered CRM panel!

Refer to our guide on how to deploy your plugins if you are deploying plugins to multiple accounts.


Building Flex plugins with React

building-flex-plugins-with-react page anchor

You now know how to build Flex Contact Center plugins using React, test them locally, then upload them to the cloud. You have the scaffolding to build whatever plugins you desire and see them reflected almost instantly in your call center instance.

Depending on your goals, we have a few paths you might want to follow next. Either explore more around plugin development with Flex and React or visit some of our other Flex Quickstarts.

We can't wait to call what you build!


Rate this page: