Intercom

Guide to integrate your Intercom with Sprinkle

Pipeline Concepts

Before setting up the Pipeline, learn about Pipeline concepts here

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer here

  • Log into Sprinkle application

  • Navigate to Ingest -> Connections Tab -> New Connection ->

  • Select Intercom

  • Provide all the mandatory details

    • Name: Name to identify this connection

  • Connect to Intercom

  • Test Connection

  • Create

STEP-2: Configure Pipeline

To learn about Pipeline, refer here

  • Navigate to Ingest -> Pipeline Tab -> Add ->

  • Select Intercom

  • Provide the name -> Create

  • Connection Tab:

    • From the drop-down, select the name of connection created in STEP-2

    • Update

STEP-3: Create Dataset

Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details

  • Report Type (Required)

    • Contacts

      • Sub Reports: Select from drop-down

    • Companies

    • Data_Attributes

      • Sub Reports: Select from drop-down

    • Tags

    • Segments

    • Articles

    • Conversations

    • Teams

  • Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.

  • Destination Schema (Required) : Data warehouse schema where the table will be ingested into

  • Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<Pipelinename>_<tablename>

  • Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.

  • Create

STEP-4: Run and schedule Ingestion

In the Ingestion Jobs tab:

  • Trigger the Job, using Run button

  • To schedule, enable Auto-Run. Change the frequency if needed

Dataset Fields

User can pick following fields in datasets

chevron-rightAdminshashtag
  • type

  • email

  • id

  • name

  • away_mode_enabled

  • away_mode_reassign

  • has_inbox_seat

  • team_ids

chevron-rightArticleshashtag
  • id

  • type

  • workspace_id

  • parent_id

  • parent_type

  • title

  • description

  • body

  • author_id

  • state

  • created_at

  • updated_at

  • url

chevron-rightCompanieshashtag
  • type

  • data

  • total_count

  • pages

chevron-rightContactshashtag

all_contacts

  • type

  • id

  • workspace_id

  • external_id

  • role

  • email

  • name

  • social_profiles_type

  • social_profiles_data

  • has_hard_bounced

  • marked_email_as_spam

  • unsubscribed_from_emails

  • created_at

  • updated_at

  • location_type

  • custom_attributes

  • tags_type

  • tags_data

  • tags_url

  • tags_total_count

  • tags_has_more

  • notes_type

  • notes_data

  • notes_url

  • notes_total_count

  • notes_has_more

  • companies_type

  • companies_data

  • companies_url

  • companies_total_count

  • companies_has_more

  • opted_out_subscription_types_type

  • opted_out_subscription_types_data

  • opted_out_subscription_types_url

  • opted_out_subscription_types_total_count

  • opted_out_subscription_types_has_more

attached_companies

  • type

  • companies

  • total_count

  • pages

attached_segements

  • type

  • data

attached_tags

  • type

  • tags

notes

  • type

  • data

  • total_count

  • pages

chevron-rightConversationshashtag
  • type

  • id

  • created_at

  • updated_at

  • source

  • contacts

  • teammates

  • title

  • admin_assignee_id

  • team_assignee_id

  • custom_attributes

  • open

  • state

  • read

  • waiting_since

  • snoozed_until

  • tags

  • first_contact_reply

  • priority

  • sla_applied

  • conversation_rating

  • statistics

  • conversation_parts

chevron-rightData_Attributeshashtag

company_attributes

  • type

  • name

  • full_name

  • label

  • description

  • data_type

  • api_writable

  • ui_writable

  • custom

  • archived

  • model

contact_attributes

  • type

  • name

  • full_name

  • label

  • description

  • data_type

  • api_writable

  • ui_writable

  • custom

  • archived

  • model

chevron-rightSegmentshashtag
  • type

  • id

  • name

  • created_at

  • updated_at

  • person_type

chevron-rightTagshashtag
  • type

  • data

chevron-rightTeamshashtag
  • type

  • teams

  • pages

Last updated