tap-intercom - Meltano Hub

Intercom

tap-intercom (singer-io variant)🥈

Conversational Relationship Platform

The tap-intercom extractor pulls data from Intercom that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-intercom extractor to your project using
```
meltano add
```
:

meltano add extractor tap-intercom

Configure the tap-intercom settings using

meltano config

meltano config tap-intercom set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-intercom test

Next steps

Follow the remaining steps of the Getting Started guide:

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

Capabilities

The current capabilities for tap-intercom may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

catalog
discover
state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-intercom settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

access_token
request_timeout
start_date
user_agent

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-intercom list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Access Token (access_token)

Environment variable: TAP_INTERCOM_ACCESS_TOKEN

Your Intercom access token. Intercom Authentication Types explains how to get an access_token. Make sure your OAuth Scope allows Read access to the endpoints above. Additionally, your App should use API Version v1.4.

Configure this setting directly using the following Meltano command:

meltano config tap-intercom set access_token [value]

Request Timeout (request_timeout)

Environment variable: TAP_INTERCOM_REQUEST_TIMEOUT

Is the time for which request should wait to get response. It is an optional parameter and default request_timeout is 300 seconds.

Configure this setting directly using the following Meltano command:

meltano config tap-intercom set request_timeout [value]

Start Date (start_date)

Environment variable: TAP_INTERCOM_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Configure this setting directly using the following Meltano command:

meltano config tap-intercom set start_date [value]

User Agent (user_agent)

Environment variable: TAP_INTERCOM_USER_AGENT

The user agent to send with requests.

Configure this setting directly using the following Meltano command:

meltano config tap-intercom set user_agent [value]

Something missing?

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

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-intercom 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.

Install

meltano add extractor tap-intercom

Maintenance Status

Repo

https://github.com/singer-io/tap-intercom

Maintainer

Meltano Stats

PyPI Stats

Keywords