Agent Notes Flex Plugin
- Flex
- JavaScript
This Twilio Flex Plugin enables your agents to take notes when they are on-call or chatting with a customer. This is an introductory plugin where the notes are stored locally for your agents. Jot down todos, ideas, research, meeting notes, and other bits of relevant information.
- Works as an add-on to your existing Flex application
- This project is based on a sample plugin developed using the Flex Plugin Builder.
- Requirements
To get started you will need the following:
- A Twilio account with a Flex environment provisioned. Create your Flex Account
- Flex Plugins CLI installed on your machine
- Twilio CLI installed on your machine
- Configure your local environment
This can be done in either steps 2A or 2B.
2A. Using the Twilio CLI
Configure your local environment to use Flex plugins by using the Flex Plugins CLI
twilio plugins:install @twilio-labs/plugin-flex@beta
twilio flex:plugins:create plugin-agent-notes --template https://github.com/twilio-labs/plugin-agent-notes
2B. Manually via GitHub
Clone the code from GitHub
Install the dependencies of the plugin. Read more.
npm install
Run and test the plugin locally by spinning up a local web-server.
twilio flex:plugins:start
OR
- Log in
Log into your Flex account via the Twilio CLI
twilio login
Visit general usage to learn more about using multiple Flex accounts.
- Deploy the plugin
Deploy and enable your plugin for your Flex application
twilio flex:plugins:deploy --major \ --changelog "Adding plugin-agent-notes via Code Exchange" \ --description "Deploying plugin-agent-notes via Code Exchange"
twilio flex:plugins:release \ --name "plugin-agent-notes" \ --description "Enabling plugin-agent-notes via Code Exchange" \ --plugin plugin-agent-notes@1.0.0