Twilio
This connector captures data from Twilio into Flow collections.
It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-twilio:dev
provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.
This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.
Supported data resources
The following data resources are supported through the Twilio APIs:
- Accounts
- Addresses
- Alerts
- Applications
- Available Phone Number Countries
- Available Phone Numbers Local
- Available Phone Numbers Mobile
- Available Phone Numbers Toll Free
- Calls
- Conference Participants
- Conferences
- Conversations
- Conversation Messages
- Conversation Participants
- Dependent Phone Numbers
- Executions
- Incoming Phone Numbers
- Flows
- Keys
- Message Media
- Messages
- Outgoing Caller Ids
- Queues
- Recordings
- Transcriptions
- Usage Records
- Usage Triggers
By default, each resource is mapped to a Flow collection through a separate binding.
Prerequisites
- Twilio Auth Token for authentication.
Configuration
You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Twilio source connector.
Properties
Endpoint
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/account_sid | Account ID | Twilio account SID | string | Required |
/auth_token | Auth Token | Twilio Auth Token. | string | Required |
/start_date | Replication Start Date | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | string | Required |
/lookback_window | Lookback window | How far into the past to look for records. (in minutes) | integer | Default |
Bindings
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/stream | Stream | Resource of your Twilio project from which collections are captured. | string | Required |
/syncMode | Sync Mode | Connection method. | string | Required |
Sample
captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-twilio:dev
config:
account_sid: <your account ID>
auth_token: <secret>
start_date: 2017-01-25T00:00:00Z
lookback_window: 7
bindings:
- resource:
stream: accounts
syncMode: full_refresh
target: ${PREFIX}/accounts
{...}