Intercom Reader
Intercom provides a unified set of messaging tools for sales, marketing, and customer care. The Intercom Reader moves data from an Intercom instance to a Striim target.
Summary information and supported objects
APIs used/data supported | Intercom API |
Supported targets | Any Striim target that accepts WAEvents |
Security and authentication | API key or OAuth |
Operations / modes supported | Initial load Incremental load Insert and update operations on supported tables |
Schema management | The Intercom Reader supports initial schema creation, which migrates the schema of the source to the target. |
Resilience / recovery | Configurable retries, A1P and E1P recovery for incremental load only, configurable resync |
Performance | Striim Platform-supported parallel execution |
Programmability |
|
Metrics and auditing | Key metrics available through Striim monitoring |
Configuring Authentication for the Intercom Reader
Before using OAuth to authenticate to Intercom, verify that you have access to an Intercom account. The following procedure configures an existing or new Intercom app to use refresh/access token pairs.
Log in to an Intercom account.
Select Settings > Apps & Integrations > Developer Hub.
The Developer Hub opens in a new browser tab.
From the developer hub, select an existing app or create a new app.
The app configuration page appears.
Select Authentication.
To use API authentication, click the copy to clipboard button in the Access Token section.
If your Striim app doesn't use OAuth to authenticate to Intercom, skip the rest of this procedure.
To configure OAuth authentication, click Edit.
The authentication options on the page become editable.
Select Use OAuth.
The Add Redirect URL link appears.
Click Add Redirect URL.
The Redirect URL field appears.
In the Redirect URL field, type a redirect URL.
Click Save.
Intercom Reader properties
Property | Type | Default value | Notes |
---|---|---|---|
Access Token | The access token used to authenticate to the Intercom instance. | ||
API key | String |
| Used to connect to an Intercom account. |
Authentication mode | Select list
| Specifies how the Intercom reader authenticates to the Intercom instance. | |
Excluded tables | String |
| A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. |
Incremental load marker | String | Value of the | The incremental load marker is a unique incremental column in each object used for incremental load. |
Migrate schema | Boolean | False | Only available in Initial Load mode. Set to |
Mode | Select list
| Controls the basic behavior of the adapter. Use the default value of | |
Polling interval | String | 5m | Specifies an interval as an integer followed by a unit. Supported units are days ( |
Start position | String | %=-1 | Value of the incremental load marker that defines the initial reading position. |
Tables | String | A semicolon-delimited ( |
The Intercom reader supports the following tables.
Companies
CompanyContacts
CompanySegments
Contacts
Conversations
Segments
DataAttributes
Tags
Teams
Admins
Notes
Metrics monitored by the Intercom Reader
The Intercom Reader monitors the following metrics.
Metric | Description |
---|---|
Number of deletes | Number of delete operations |
Number of DDLs | Number of data definition language operations |
Number of PKUpdates | Number of primary key update operations |
Number of updates | Number of update operations |
Number of inserts | Number of insert operations |