Programmers reference for Intercom Reader

Authentication mode

Select list

(none)

Specifies how the reader authenticates to Intercom.

API key

String

Server-side access token used when Authentication mode is API key.

Access token

Password

Access token used when Authentication mode is OAuth. Provide a refresh token when long-running unattended access is required.

Migrate schema

Boolean

False

Available in Initial Load. When enabled, propagates object schema from source to target.

Mode

Select list

Initial load

Initial load copies existing data and stops; Incremental load continuously captures changes.

Polling interval

String

5m

Integer + unit (d/h/m/s). Controls how often the reader polls for changes.

Start position

String

%=-1

Specifies the initial reading position for each table based on the incremental marker. % applies to all tables; -1 starts from the earliest supported point forward. You may set per-table values, for example: Companies=0;Segments=-1.

Incremental load marker

String

UpdatedAt

Name of the column used for incremental reads. Must be a timestamp or strictly increasing numeric value.

Tables

String

Semicolon-delimited list of tables to read. Supports % wildcard. Do not modify this while recovery is enabled.

Excluded tables

String

Tables to exclude (useful when Tables uses wildcards). Excluding Conversations may be necessary if your plan does not permit access.

Thread pool count

Integer

10

Number of parallel threads used for reads. Typically one per active table yields best throughput.

The ThreadPoolCount value must be less than the number of available processors. For example, if the system has eight processors, set ThreadPoolCount to 7 or lower.

Connection pool size

Integer

20

Maximum active HTTP connections. Avoid setting thread pool higher than connection pool.