This connector captures data from Intercom into Flow collections.
It is available for use in the Flow web application. For local development or open-source workflows,
ghcr.io/estuary/source-intercom: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 Intercom API:
- Company attributes
- Company segments
- Contact attributes
- Conversation parts
By default, each resource is mapped to a Flow collection through a separate binding.
There are two ways to authenticate with Intercom:
In the Flow web app, you sign in directly. You'll need the username and password associated with a user with full permissions on your Intercom workspace.
Using the flowctl CLI, you configure authentication manually. You'll need the access token for you Intercom account.
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 Intercom source connector.
The properties in the table below reflect manual authentication using the CLI. In the Flow web app, you'll sign in directly and won't need the access token.
|Access token||Access token for making authenticated requests.||string||Required|
|Start date||UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.||string||Required|
|Stream||Resource from Intercom from which collections are captured.||string||Required|
|Sync Mode||Connection method.||string||Required|
The sample below reflects manual authentication in the CLI.