Skip to main content

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

  • Wizards

  • Striim Flow Designer

  • Striim TQL

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.

  1. Log in to an Intercom account.

  2. Select Settings > Apps & Integrations > Developer Hub.

    The Developer Hub opens in a new browser tab.

  3. From the developer hub, select an existing app or create a new app.

    The app configuration page appears.

  4. Select Authentication.

  5. 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.

  6. To configure OAuth authentication, click Edit.

    The authentication options on the page become editable.

  7. Select Use OAuth.

    The Add Redirect URL link appears.

  8. Click Add Redirect URL.

    The Redirect URL field appears.

  9. In the Redirect URL field, type a redirect URL.

  10. 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

  • API key

  • OAuth

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 updatedAt field.

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 True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list

  • Initial load

  • Incremental load

Controls the basic behavior of the adapter. Use the default value of InitialLoad to read all existing data, then stop. Set the value to IncrementalLoad to read all new data continuously.

Polling interval

String

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The Intercom reader polls the Intercom instance at the specified interval.

Start position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the Intercom instance. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

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