The tap-twilio Meltano extractor pulls data from the Twilio API that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

Using the Command Line Interface

  1. Add the tap-twilio extractor to your project using meltano add : 

    meltano add extractor tap-twilio
  2. Configure the settings below using meltano config .

Using Meltano UI

  1. Start Meltano UI using meltano ui: 

    meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “Twilio”.
  4. Configure the settings below in the “Configuration” interface that opens automatically.

Next steps

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Settings

tap-twilio requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Account String ID (account_sid)

This is the String ID of your account which can be found in the account console at twilio.com/console.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable: 

meltano config tap-twilio set account_sid <account_sid>

export TAP_TWILIO_ACCOUNT_SID=<account_sid>

Auth Token (auth_token)

This is the authorization token for your account which can be found in the account console at twilio.com/console.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable: 

meltano config tap-twilio set auth_token <auth_token>

export TAP_TWILIO_AUTH_TOKEN=<auth_token>

Date Window Days (date_window_days)

This is the integer number of days (between the from and to dates) for date-windowing through the date-filtered endpoints.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable: 

meltano config tap-twilio set date_window_days 30

export TAP_TWILIO_DATE_WINDOW_DAYS=30

Start Date (start_date)

This is the absolute beginning date from which incremental loading on the initial load will start

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable: 

meltano config tap-twilio set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_TWILIO_START_DATE=YYYY-MM-DDTHH:MM:SSZ

User Agent (user_agent)

This is used to identify the process running the tap.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable: 

meltano config tap-twilio set user_agent <user_agent>

export TAP_TWILIO_USER_AGENT=<user_agent>

Looking for help?

If you're having trouble getting the tap-twilio extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page?

This page is generated from a YAML file that you can contribute changes to!