ExportConfiguration resource

The ExportConfiguration resource enables daily automatic generation of files (Twilio Editions customers only) and sets the callback method for notification when file generation completes.

Bulk export automation

(information)

Twilio Editions feature

Bulk export automation for daily file exports is available to all Twilio Editions customers. Learn more about Editions.

You can set daily automatic exports of activity logs from the Twilio platform. Automatic daily exports generate one data file per day for every resource enabled. The system typically attempts to create a data file based on the state of the data at the time of creation, but delays are possible.

Set the callback method to notify when a file is complete

If you use bulk export automation or custom jobs, you can send a callback by webhook or email to notify you when a file is ready:

For webhooks, the webhook method value must be either GET or POST and the webhook URL value should be the URL of the service you want to call when the file is available.
For email, the email value should be a valid email address.

Configuration Properties

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Optional

Not PII

If true, Twilio will automatically generate every day's file when the day is over.

webhookUrlstring<uri>

Optional

Not PII

Stores the URL destination for the method specified in webhook_method.

webhookMethodstring

Optional

Not PII

Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url

resourceTypestring

Optional

Not PII

The type of communication – Messages, Calls, Conferences, and Participants

urlstring<uri>

Optional

Not PII

The URL of this resource.

Fetch an ExportConfiguration resource

GET https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration

Path parameters

Property nameTypeRequiredPIIDescription

resourceTypestring

required

Not PII

The type of communication – Messages, Calls, Conferences, and Participants

Fetch an Export Configuration for Messages

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Messages")
13    .fetch();
14
15  console.log(exportConfiguration.enabled);
16}
17
18fetchExportConfiguration();

Response

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "",
5  "webhook_method": "",
6  "resource_type": "Messages"
7}

Fetch an Export Configuration for Calls

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Calls")
13    .fetch();
14
15  console.log(exportConfiguration.enabled);
16}
17
18fetchExportConfiguration();

Response

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "",
5  "webhook_method": "",
6  "resource_type": "Calls"
7}

Update an ExportConfiguration resource

POST https://bulkexports.twilio.com/v1/Exports/{ResourceType}/Configuration

Path parameters

Property nameTypeRequiredPIIDescription

resourceTypestring

required

Not PII

The type of communication – Messages, Calls, Conferences, and Participants

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

enabledboolean

Optional

Not PII

If true, Twilio will automatically generate every day's file when the day is over.

webhookUrlstring<uri>

Optional

Not PII

Stores the URL destination for the method specified in webhook_method.

webhookMethodstring

Optional

Not PII

Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url

Update Export Configuration

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateExportConfiguration() {
11  const exportConfiguration = await client.bulkexports.v1
12    .exportConfiguration("Messages")
13    .update({
14      webhookMethod: "GET",
15      webhookUrl: "https://api.your-infrastructure.com/receive-messages/",
16    });
17
18  console.log(exportConfiguration.enabled);
19}
20
21updateExportConfiguration();

Response

1{
2  "url": "https://bulkexports.twilio.com/v1/Exports/Messages/Configuration",
3  "enabled": true,
4  "webhook_url": "https://api.your-infrastructure.com/receive-messages/",
5  "resource_type": "Messages",
6  "webhook_method": "GET"
7}