Intercom Collect Slice

Overview

Intercom is a leading customer messaging platform which allows businesses to communicate with prospective and existing customers within their app, on their website, through social media, or via email.

The Datacoral Intercom slice collects data from an intercom account and enable data flow of users, teams, and conversations into a data warehouse, such as Redshift.

Steps to add this slice to your installation via web app

The steps to launch your slice are:

  1. Connect your Intercom account
  2. Authorize auth token access
  3. Add the Intercom slice

1. Connect your Intercom account

Setup requirements

Before getting started please make sure to have the following information:

  • Access to an active intercom account

Setup instructions

The Intercom slice can connect to your account through the following steps:

  1. Select the Intercom slice type from the available list
  2. Click "Connect Your Intercom Account"
  3. Log in to your Intercom account

2. Authorize auth token access

By connecting your account, an auth token will be prepared for the slice to use. The Intercom slice requires this auth token to collect data.

Please review the set of permissions Datacoral is requesting this token to be created with. After reviewing the permissions, click "Authorize access" to provide Datacoral the requested token and return to the Datacoral web app.

3. Add the slice

After returning to the Datacoral web app, you will be asked to provide a name and destination warehouse for the Intercom slice. Then click "Add Slice".

Steps to add this slice to your installation via CLI

The steps to launch your slice are:

  1. Generate Intercom API keys
  2. Specify the slice config
  3. Add the Intercom slice

1. Generate Intercom API keys

Setup requirements

Before getting started please make sure to have the following information:

  • Access to an active Intercom account

Setup instructions

The Intercom slice requires an auth token to collect data. An auth token can be obtained from Intercom through the following steps:

  1. Log in to your Intercom account
  2. Click "Account" → your account, in the left sidebar menu
  3. Navigate to Authentication → "OAuth Tokens"
  4. Your OAuth token will display on the page. Copy the token.

2. Specify the slice config

To get a template for the Intercom slice configuration save the output of the describe --input-parameters command as follows:

datacoral collect describe --slice-type intercom \
--input-parameters > intercom_parameters_file.json

Example template:

{
"auth_token": "test"
}

Modify the intercom_parameters_file file to add the auth_token generated from Intercom

3. Add the Slice

datacoral collect add --slice-type intercom --slice-name <slice-name> --parameters-file <params-file>
  • slice-name Name of your slice. A schema with your slice-name is automatically created in your warehouse
  • params-file File path to your input parameters file. Ex. intercom_parameters_file.json

Supported load units

  • users: this loadunit is used to store information about particular users

  • events: this loadunit is used to store information about a particular user's events

    • this loadunit supports an incremental fetch mode
  • notes: this loadunit is used to store information about a particular user's notes

    • this loadunit supports an incremental fetch mode
  • conversations: this loadunit is used to store information about particular conversations

    • this loadunit supports an incremental fetch mode
  • conversation_parts: this loadunit is used to store information about a particular converstaion's parts

    • this loadunit supports an incremental fetch mode
  • leads: this loadunit is used to store information about particular leads

  • admins: this loadunit is used to store information about particular admins

  • companies: this loadunit is used to store information about particular companies

  • segments: this loadunit is used to store information about particular segments

    • this loadunit supports an incremental fetch mode
  • tags: this loadunit is used to store information about particular tags

  • teams: this loadunit is used to store information about particular teams

    Slice output

    Output of this slice is stored in S3 and the destination warehouse.

    AWS S3 Data stored in AWS S3 is partitioned by date and time s3://customer_installation.datacoral/<slice-name>

    Destination Warehouse: Schema - schema name will be same as a slice-name. Tables produced by the slice are:

- schema.users
- schema.events
- schema.notes
- schema.conversations
- schema.conversation_parts
- schema.leads
- schema.admins
- schema.companies
- schema.segments
- schema.tags
- schema.teams

Questions? Interested?

If you have questions or feedback, feel free to reach out at hello@datacoral.co or Request a demo