Intercom

​

What’s Supported

​

Supported Actions

The Intercom connector supports:

• Read Actions, including full historic backfill. Please note that incremental read is not supported, a full read of the Intercom instance will be done for each scheduled read.
• Write Actions.
• Proxy Actions, using the base URL https://api.intercom.io.

​

Supported Objects

The Intercom connector supports writing to and reading from the following objects:

• Admins
• Articles
• Collections
• Companies
• Contacts
• Conversations
• Data Attributes
• Events
• Help Centers
• News Items
• Newsfeeds
• Segments
• Subscription Types
• Tags
• Teams
• Ticket Types

​

Example Integration

For an example manifest file of a Intercom integration, visit our samples repo on Github.

​

Before You Get Started

To integrate Intercom with Ampersand, you need to Create an Intercom Account and obtain the following credentials from an Intercom App:

• Client ID
• Client Secret

​

Create an Intercom Account

You need an Intercom account to connect with Ampersand. If you do not have an Intercom account, here’s how you can sign up:

• Go to the Intercom Developer site and sign up for a free developer account.

​

Creating an Intercom App

Once your Intercom Developer account is ready, you need to create an Intercom application. Learn more about creating an Intercom application here.

1. Log in to Your Intercom Developer Dashboard.
2. Click New App and follow the prompts to create your app.
3. Click Create App.

​

Adding Ampersand Redirect URL to Intercom App

Ampersand uses a redirect URL to integrate with your Intercom app.

Follow the steps below to add the Ampersand URL to Intercom:

1. Go to your Intercom developer dashboard and select your application.

2. Navigate to Configure > Authentication and click Edit.

3. Enable the Use OAuth option.

4. In the Redirect URL section, click Add URL and add the Ampersand redirect URL: https://api.withampersand.com/callbacks/v1/oauth.

   

​

Accessing Client ID and Client Secret

Once your app is created, Intercom provides your Client ID and Client Secret which will is used to add your Intercom App to Ampersand.

Here’s how you can obtain the credentials you’ll need:

1. Go to your Intercom developer dashboard and select your application.
2. You will find your Client ID and Client Secret under the Basic Information section.

You can now add your Intercom App Details to Ampersand.

​

Add Intercom App Details in Ampersand

1. Log in to your Ampersand Dashboard.

2. Select the project where you want to add the Intercom App.

   

   
   

3. Select Provider apps.

4. Select Intercom from the Provider list.

5. Enter the previously obtained Client ID in the Client ID field and the Client Secret in the Client Secret field.

   
   

   

6. Click Save Changes.

​

Using the connector

To start integrating with Intercom:

• Create a manifest file like the example, see Define Integrations for more info.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Write Actions, you can start making API calls to our Write API.
  • If your integration has Proxy Actions, you can start making Proxy API calls.