Run Flex Insights on a Custom Domain

(new)

Public beta

Flex Insights (also known as Historical Reporting) is currently available as a public beta release and the information contained in the Flex Insights documentation is subject to change. This means that some features are not yet implemented and others may be changed before the product is declared as generally available. Public beta products are not covered by a Twilio SLA.

Any reference to "Historical Reporting", "Flex Insights API", "Flex Insights Historical Reporting", or "Flex Insights Historical Reporting API" in the Flex Insights documentation refers to Flex Insights.

To run Flex Insights Historical Reporting on a custom domain, ask Twilio Support to allow access from the domains your self-hosted Flex runs on. This page guides you through enabling Historical Reporting for self-hosted Flex and for your local development environment.

If you use hosted Flex on the flex.twilio.com domain, you do not need to take any action. Access to Flex Insights Historical Reporting from the flex.twilio.com domain is allowed by default. If you still have difficulty accessing Historical Reporting, contact Twilio Support.

Self-Hosted Flex on Custom Domain

If you use self-hosted Flex you need to ask our support team to allow access from domains that Flex runs on. Follow these steps:

Check that the address in your browser address bar does not start with flex.twilio.com.
Create a list of all domains on which you plan to run Flex, so you can ask to enable access for all of them at once. Don't forget development, staging, and testing instances.
Contact our support team with a request to enable access to the domains you have collected. Provide support with account SIDs associated with every domain you need to allow.
Wait for confirmation that your domains are allowed to access Historical Reporting.

After these steps are completed you can take advantage of Historical Reporting programmability.

Local Development

To access Historical Reporting from localhost during development, run a local proxy service. When embedding Historical Reporting into your customized Flex, you might need to access Historical Reporting from localhost. Twilio does not enable CORS to access Historical Reporting from localhost because it poses a security risk.

To help with development, Twilio provides a proxy server that you can run locally. Run the package with npx @twilio/flex-ui-dev-proxy. By default it runs on localhost:8081, but you can configure both host and port. Refer to the README.md for more details.

When you run insights locally, you also need to set the URL to your insights analytics proxy URL in the appConfig.js file. For example:

1{
2    insights: {
3        analyticsUrl: "http://localhost:8081"
4    }
5}

Using the Proxy in your own stack

While running the proxy as a separate process is recommended, it is possible to import just the express middleware or webpack proxy configuration object from the package, so that you can use it in your own stack. Refer to the README.md for more information.