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.

PluginRelease Properties

Property nameTypePIIDescription

sidSID<FK>

Not PII

The unique string that we created to identify the Plugin Release resource.

Pattern: ^FK[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

Not PII

The SID of the Account that created the Plugin Release resource and owns this resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

configuration_sidSID<FJ>

Not PII

The SID of the Plugin Configuration resource to release.

Pattern: ^FJ[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time>

Not PII

The date and time in GMT when the Flex Plugin Release was created specified in ISO 8601 format.

urlstring<uri>

Not PII

The absolute URL of the Plugin Release resource.

Create a PluginRelease resource

POST https://flex.twilio.com/v1/PluginService/Releases

Headers

Property nameTypeRequiredPIIDescription

Flex-MetadatastringOptional

Not PII

The Flex-Metadata HTTP request header

Request body parameters

Property nameTypeRequiredPIIDescription

ConfigurationIdstringrequired

Not PII

The SID or the Version of the Flex Plugin Configuration to release.

Create a PluginRelease

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function createPluginRelease() {
_18  const pluginRelease = await client.flexApi.v1.pluginReleases.create({
_18    configurationId: "ConfigurationId",
_18  });
_18
_18  console.log(pluginRelease.sid);
_18}
_18
_18createPluginRelease();

Output


_10{
_10  "sid": "FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2020-01-10T20:00:00Z",
_10  "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Fetch a PluginRelease resource

GET https://flex.twilio.com/v1/PluginService/Releases/{Sid}

Headers

Property nameTypeRequiredPIIDescription

Flex-MetadatastringOptional

Not PII

The Flex-Metadata HTTP request header

Path parameters

Property nameTypeRequiredPIIDescription

Sidstringrequired

Not PII

The SID of the Flex Plugin Release resource to fetch.

Fetch a PluginRelease

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function fetchPluginRelease() {
_16  const pluginRelease = await client.flexApi.v1.pluginReleases("Sid").fetch();
_16
_16  console.log(pluginRelease.sid);
_16}
_16
_16fetchPluginRelease();

Output


_10{
_10  "sid": "Sid",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "configuration_sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "date_created": "2020-01-10T20:00:00Z",
_10  "url": "https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Read multiple PluginRelease resources

GET https://flex.twilio.com/v1/PluginService/Releases

Headers

Property nameTypeRequiredPIIDescription

Flex-MetadatastringOptional

Not PII

The Flex-Metadata HTTP request header

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple PluginReleases

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listPluginRelease() {
_18  const pluginReleases = await client.flexApi.v1.pluginReleases.list({
_18    limit: 20,
_18  });
_18
_18  pluginReleases.forEach((p) => console.log(p.sid));
_18}
_18
_18listPluginRelease();

Output


_12{
_12  "releases": [],
_12  "meta": {
_12    "page": 0,
_12    "page_size": 50,
_12    "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0",
_12    "previous_page_url": null,
_12    "url": "https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0",
_12    "next_page_url": null,
_12    "key": "releases"
_12  }
_12}