Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

Plugin Resource

A Plugin is a resource that contains information about a given plugin, like its name, description, and the account that owns the plugin.

While the Plugin Version Resource contains information on the actual source code for a deployed Plugin, the Plugin Resource serves as an identifier for the Plugin itself. For example, you might have a CRM plugin. You can use the Plugin Resource to describe the plugin itself, and then a series of Plugin Versions to reference the source code of your various iterations of the Plugin.

Plugin Properties

plugin-properties page anchor
Property nameTypePIIDescription
sidSID<FP>
Not PII

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

Pattern: ^FP[0-9a-fA-F]{32}$Min length: 34Max length: 34
account_sidSID<AC>
Not PII

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

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

The name that uniquely identifies this Flex Plugin resource.

friendly_namestring
PII MTL: 30 days

The friendly name this Flex Plugin resource.

descriptionstring
PII MTL: 30 days

A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long

archivedboolean
Not PII

Whether the Flex Plugin is archived. The default value is false.

date_createdstring<date-time>
Not PII

The date and time in GMT-7 when the Flex Plugin was created specified in ISO 8601(link takes you to an external page) format.

date_updatedstring<date-time>
Not PII

The date and time in GMT-7 when the Flex Plugin was last updated specified in ISO 8601(link takes you to an external page) format.

urlstring<uri>
Not PII

The absolute URL of the Flex Plugin resource.

linksobject<uri-map>
Not PII

Create a Plugin resource

create-a-plugin-resource page anchor
POST https://flex.twilio.com/v1/PluginService/Plugins

Headers

headers page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Request body parameters

request-body-parameters page anchor
Property nameTypeRequiredPIIDescription
UniqueNamestringrequired
PII MTL: 30 days

The Flex Plugin's unique name.

FriendlyNamestringOptional
PII MTL: 30 days

The Flex Plugin's friendly name.

DescriptionstringOptional
PII MTL: 30 days

A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long

Create a Plugin

create-a-plugin page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const 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
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function createPlugin() {
_18
const plugin = await client.flexApi.v1.plugins.create({
_18
uniqueName: "UniqueName",
_18
});
_18
_18
console.log(plugin.sid);
_18
}
_18
_18
createPlugin();

Output

_14
{
_14
"sid": "FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"unique_name": "UniqueName",
_14
"friendly_name": "friendly name",
_14
"description": "description",
_14
"archived": false,
_14
"date_created": "2020-01-10T20:00:00Z",
_14
"date_updated": "2020-01-10T20:00:00Z",
_14
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"links": {
_14
"plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"
_14
}
_14
}

Fetch a Plugin resource

fetch-a-plugin-resource page anchor
GET https://flex.twilio.com/v1/PluginService/Plugins/{Sid}

Headers

headers-1 page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
Sidstringrequired
Not PII

The SID of the Flex Plugin resource to fetch.

Fetch a Plugin

fetch-a-plugin page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_16
// Download the helper library from https://www.twilio.com/docs/node/install
_16
const 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
_16
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16
const authToken = process.env.TWILIO_AUTH_TOKEN;
_16
const client = twilio(accountSid, authToken);
_16
_16
async function fetchPlugin() {
_16
const plugin = await client.flexApi.v1.plugins("Sid").fetch();
_16
_16
console.log(plugin.sid);
_16
}
_16
_16
fetchPlugin();

Output

_14
{
_14
"sid": "Sid",
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"unique_name": "unique-name",
_14
"friendly_name": "friendly name",
_14
"description": "description",
_14
"archived": false,
_14
"date_created": "2020-01-10T20:00:00Z",
_14
"date_updated": "2020-01-10T20:00:00Z",
_14
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"links": {
_14
"plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"
_14
}
_14
}

Read multiple Plugin resources

read-multiple-plugin-resources page anchor
GET https://flex.twilio.com/v1/PluginService/Plugins

Headers

headers-2 page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Query parameters

query-parameters page anchor
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 Plugins

list-multiple-plugins page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_16
// Download the helper library from https://www.twilio.com/docs/node/install
_16
const 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
_16
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16
const authToken = process.env.TWILIO_AUTH_TOKEN;
_16
const client = twilio(accountSid, authToken);
_16
_16
async function listPlugin() {
_16
const plugins = await client.flexApi.v1.plugins.list({ limit: 20 });
_16
_16
plugins.forEach((p) => console.log(p.sid));
_16
}
_16
_16
listPlugin();

Output

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

Update a Plugin resource

update-a-plugin-resource page anchor
POST https://flex.twilio.com/v1/PluginService/Plugins/{Sid}

Headers

headers-3 page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
Sidstringrequired
Not PII

The SID of the Flex Plugin resource to update.

Request body parameters

request-body-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
FriendlyNamestringOptional
PII MTL: 30 days

The Flex Plugin's friendly name.

DescriptionstringOptional
PII MTL: 30 days

A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long

Update a Plugin

update-a-plugin page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const 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
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function updatePlugin() {
_18
const plugin = await client.flexApi.v1
_18
.plugins("Sid")
_18
.update({ friendlyName: "FriendlyName" });
_18
_18
console.log(plugin.sid);
_18
}
_18
_18
updatePlugin();

Output

_14
{
_14
"sid": "Sid",
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"unique_name": "unique-name",
_14
"friendly_name": "FriendlyName",
_14
"description": "description update",
_14
"archived": false,
_14
"date_created": "2020-01-10T20:00:00Z",
_14
"date_updated": "2020-01-10T20:00:00Z",
_14
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"links": {
_14
"plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions"
_14
}
_14
}

Rate this page: