Plugin Release Resource
The Plugin Release resource lets you set a Configuration active on a Flex project. A Flex project can have multiple Plugins with different Versions. When you're confident that your Plugins all work properly and are ready for production, you can create a release to push the changes to your contact center.
This allows you to audit when a Flex project changed and rollback your changes when necessary. Releases are immutable and irreversible . A rollback requires a new Release using a previous Configuration.
Resource properties The unique string that we created to identify the Plugin Release resource.
configuration_sid
type: SID<FJ> Not PIIThe SID of the Plugin Configuration resource to release.
date_created
type: string<DATE TIME> Not PIIThe absolute URL of the Plugin Release resource.
POST https://flex-api.twilio.com/v1/PluginService/Releases
Request headers
The Flex-Metadata HTTP request header
Request body parameters Required
The SID or the Version of the Flex Plugin Configuration to release.
_12 // Download the helper library from https://www.twilio.com/docs/node/install
_12 // Find your Account SID and Auth Token at twilio.com/console
_12 // and set the environment variables. See http://twil.io/secure
_12 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12 const authToken = process.env.TWILIO_AUTH_TOKEN;
_12 const client = require('twilio')(accountSid, authToken);
_12 client.flexApi.v1.pluginReleases
_12 configurationId: 'FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_12 .then(plugin_release => console.log(plugin_release.sid));
_10 "sid": "FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "configuration_sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2020-01-10T20:00:00Z",
_10 "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://flex-api.twilio.com/v1/PluginService/Releases/{Sid}
Request headers
The Flex-Metadata HTTP request header
URI parameters Path Parameter
The SID of the Flex Plugin Release resource to fetch.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.flexApi.v1.pluginReleases('FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(plugin_release => console.log(plugin_release.sid));
_10 "sid": "FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "configuration_sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "date_created": "2020-01-10T20:00:00Z",
_10 "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
GET https://flex-api.twilio.com/v1/PluginService/Releases
Request headers
The Flex-Metadata HTTP request header
URI parameters Query Parameter
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Query Parameter
The page index. This value is simply for client state.
Query Parameter
The page token. This is provided by the API.
_10 // Download the helper library from https://www.twilio.com/docs/node/install
_10 // Find your Account SID and Auth Token at twilio.com/console
_10 // and set the environment variables. See http://twil.io/secure
_10 const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10 const authToken = process.env.TWILIO_AUTH_TOKEN;
_10 const client = require('twilio')(accountSid, authToken);
_10 client.flexApi.v1.pluginReleases
_10 .then(pluginReleases => pluginReleases.forEach(p => console.log(p.sid)));
_20 "sid": "FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "configuration_sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_20 "date_created": "2020-01-10T20:00:00Z",
_20 "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_20 "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0",
_20 "previous_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0",
_20 "url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0",
_20 "next_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=1",