About the Intercom category

[anon99371720]

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Intercom API Reference

Connector package documentation

Table of Contents

• 1. Setting up HTTP Client Intercom
  • 1.1 Steps
• 2. Subscribing to entities from Intercom
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Intercom
  • 3.1 Steps
  • 3.2 General concept

1. Setting up HTTP Client Intercom

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
2. Select Intercom HTTP Client as PlatForm and click the next step
3. Fill in the Base URI and then Choose the Authentication Type.
4. If you choose Oauth, fill in Authorize URL, Access Token URL, Client ID, and Client Secret.
   (For more information, see Intercom Oauth Authentication Reference)
   Click on “Grant access to Intercom” and you will be redirected to approve the grant.
5. Fill in the Access token if you prefer to choose Access Token as an Authentication Type.
   (For more information, see Intercom Access Token Authentication Reference)
6. You can optionally enable logging of requests to get the log of the authentication.
7. Click the next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use.
   
   

2. Subscribing to Entities from Intercom

2.1 Steps

1. Go to Connections → Incoming and create a new incoming configuration, and select “Intercom Subscriber” as the subscriber.
2. Select the entity you want to subscribe to from Intercom.
3. Add any request parameters needed to subscribe to the entity.
4. Select the Intercom HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from Intercom.
6. You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept

We follow Intercom documentation on building this connector, so you can easily use the connector based on Intercom API Reference.

Entity

The entity you want to subscribe to Intercom. Please refer to the entities from Intercom API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Intercom API Reference .

Please look at the example below on how to fill the path field when subscribing “Tickets - retrieve a ticket.” entity.

Based on the documentation, we can see that the endpoint requires “id” as a parameter. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Intercom with the URL /tickets/3

• Path is the path parameter of the url. For example, the {id}.
• Query is a set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Intercom.

3. Publishing Entity to Intercom

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration, and select “Intercom Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the Intercom entity in which you want the data to be published.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Put method, and HTTP Delete method on submitting data to Intercom.

Entity

We support publishing to most Intercom endpoints.
Please refer to Intercom API Reference page.

For example, we want to add a tag to the ticket. Please select “Post” as the Method and “Tags - Add tag to a ticket” as the entity of the publisher.

Based on the documentation, it requires a path ticket_id and a request body. That is why we set the ticket_id inside the path key and the request body inside the payload key inside Alumio data.

Alumio will send an API request to Intercom with URL /tickets/3/tags

• Path is the path parameter of the url. For example, the {id}.
• Query is a set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Intercom.