Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 472 Topics
  • 1,068 Replies
472 Topics
J
Jean-BaptisteNew Participant
asked in API & Webhooks
How can I post a message as Operator

I made an app that post messages into conversations using the Intercom API, and I want those messages to come from a bot/operator, not from the contact nor the admin. Here is a screenshot of an app that posted such a message, but I cannot find how to achieve this in the API docs… Thanks for your help! 

6
R
Top Expert
3 years ago
U
User1140Active User
asked in API & Webhooks
Initiate Outbound chat from within a webpage, with passed parameters.

We have mentors who go over our clients (students) homework. I want them to be able to initiate chats with a student if they have a note about a specific homework task hey submitted. (i.e. "your answer to question 13 is incomplete"). Mentors have users in our Intercom (they are team members), but I want the mentors to be able to launch the chat from the UI they use to check students homework rather than go into intercom look up the user and initiate a chat.  So I want them to be able to click a button next to a task they are checking, which will pop up either the messenger or any other way to send a message, where the user is already set (based on the email of the student I will pass to Intercom) and the task name/number included in the default text. Is there a way to achieve this natively, via an integration or via API?  

2
U
3 years ago
C
Claus NNew Participant
asked in API & Webhooks
Is there any way to set the language_override attribute on a Contact?

The Contacts model have an attribute called language_override, but when I try to set it when creating a new Contact, or to update it on an existing Contact the attribute seems to be ignored. Docs also doesn't mention it for those operations, so I guess that is as-designed. Is there any way I can change it?

1
R
Top Expert
3 years ago
A
Andy GNew Participant
asked in API & Webhooks
Is there a way to set the "Assign replies to" value to a message via the API?

I can create a message and send it to a user, but when they reply it goes to the admin who created the message. I'd like to have this assigned to a group instead, which I can do in the Intercom UI. There doesn't appear to be an option to set that via API.

2
A
3 years ago
I
Iain WNew Participant
asked in API & Webhooks
Webhook for a user resubscribing to receive emails

Hi, We are using webhooks to fire events when a user unsubscribes from receiving emails. This is working fine, but we also want to fire events when a user re-subscribes. I can't see any documentation capturing a specific resubscribe event, but is it possible to capture this event using another webhook? Edit:If the above is not possible, is it possible to remove the 'resubscribe' link from the 'you have susccesfully unsubscribed from emails page' Alternatively, can we redirect from the 'you have unsubscribed' page to our own URL, i.e. our own custom 'you have unsubscribed from our emails' page?

2
Eric Fitz
3 years ago
P
PushkarNew Participant
asked in API & Webhooks
Is it possible to get the values of user attributes programatically?

Is is possible to get the user attributes from intercom to javascript function on my webpage? I want to use intercom attributes in some of the pages.

3
Eric Fitz
3 years ago
A
Artur GNew Participant
asked in API & Webhooks
Question re Intercom's Ruby gem

Hello, in gem for Ruby on Rails a filter is used :before yet it doesnt seem to work as API doesnt give a response or gives a response ignoring the filter. Perhaps a gem problemIs there a way to send a request with a date range?API v1.3

1
L
3 years ago
S
StoryXpressNew Participant
asked in API & Webhooks
Events creation not happening on leads using Intercom API, also how to filter user on events metadata?

Hello everyone,I was trying events creation API on postman and have correct recently created a lead from the lead API.The lead API successfully created a lead with the provided details, and I tried adding an event to this user, this event API gave 404 error user was not found.I also tried this event creation on the leads that were captured from the conversation message & also tried it with manually added leads created on the Intercom platform but still the event API was returning 404 error.But this event creation is successfully happening on users that were earlier leads.The API call returned 200 and I can also see the event addition on the platform. Pic: Events addition failed and says user not found Pic: Lead is present in Intercom Pic: Adding event on leads works perfectly My question was is there some limitation on the lead's side from the backend of Intercom, which stops adding events in lead?If not then what's the correct way of doing it. Also, I wanted to know how ca

5
S
3 years ago
S
StoryXpressNew Participant
asked in API & Webhooks
Can we create custom attributes which can hold multiple values

Hello everyone,I had a use case where we need to report the video activities watched by the user.I was using the custom attributes to save the video activities.The custom attribute I created was video_view with a datatype of list.Now every time a user watches a video I update the list attribute with a new video name and then update the video_view (custom attribute) value to this video name in the lead data. Now the issue is, if 2 videos are watched by the lead we would have to add 2 values to video_view(custom attribute) but the list attribute can only store 1 video name at a time whereas the user watched 2 videos.So I was thinking of custom attribute which can have multiple values.If there is any better approach let me know. Also why I am using custom attribute is because operator on the Intercom can easily filter out the user based on the video name.If possible can we have an object type in custom_attribute so that we can store further details in the same attribute? 

2
S
3 years ago
U
User1122New Participant
asked in API & Webhooks
How to customize message on Intercom for Cordova & Phonegap

Hey, i want to send my user a custom message, on web it is with 'showNewMessage ' and the custom message. if i want to do the same thing but on Intercom for Cordova & Phonegap, is there a way to do so?

1
Eric Fitz
3 years ago
M
MineshNew Participant
asked in API & Webhooks
Can I send Banner messages through the API?

I would like to automate banner messages sent to users. Are there any plans to expose this in the API? My Requirement: When we do an application release, we want to display 3 banners in order:Tell everyone that is logged in that there is about to be a release in X minutesTell everyone that a release is in progressTell everyone that a release is done We are using the user interface to do this, but it is quite a manual process which we would like to streamline using the API.

1
Eric Fitz
3 years ago
A
Ashish BNew Participant
posted in API & Webhooks
Java SDK: Getting java.io.FileNotFoundException: https://api.intercom.io//events

I am using Java SDK to send events to intercom. It works on local machine, but now AWS. I get below exceptionjava.io.FileNotFoundException: https://api.intercom.io//events java.io.FileNotFoundException:https://api.intercom.io//events atjava.base/sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1920) at java.base/sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1520) at java.base/java.net.HttpURLConnection.getResponseCode(HttpURLConnection.java:527) at java.base/sun.net.www.protocol.https.HttpsURLConnectionImpl.getResponseCode(HttpsURLConnectionImpl.java:334) at io.intercom.api.HttpClient.runRequest(HttpClient.java:151) at io.intercom.api.HttpClient.executeHttpMethod(HttpClient.java:110) at io.intercom.api.HttpClient.post(HttpClient.java:100) at io.intercom.api.DataResource.create(DataResource.java:25) at io.intercom.api.Event.create(Event.java:35)  

1
Eric Fitz
3 years ago
J
JanuszNew Participant
asked in API & Webhooks
Is it possible to register a push notification token for a user using the web API?

We have our product running for a couple years now. There's a lot of users. When we started with intercom there either wasn't any option for supporting push notifications or we just didn't find it enticing enough. Now we would like to enable push notifications in intercom. We have thousands of push notification tokens in our DB that we use in our product. Is there any option to use those tokens and just synchronize them to the users in Intercom or is the only possible option to use the iOS SDK in our app?

6
J
3 years ago
D
dnkNew Participant
asked in API & Webhooks
How to identify from which user/account/workspace a webhook notification generated?

Hi Team, I'm trying to create a webhook for my app that having OAuth authentication (i.e. Intercom users can install my app on their account/workspace). In my app, users can create separate functions to be executed for each type of intercom notification topic e.g. 'contact.created' topic triggers function1 and 'company.created' topic triggers function2 ...etc. So for example, if user1 creates 2 different functions for 'contact.created' & 'company.created' and another user2 creates few more functions for different notification topics for that user's account/workspace.  With webhooks how do we distinguish from which user or workspace the notification is generated? Webhook json payload does not seem having any field that allowing me to uniquely identify user/account/workspace where the event occur? or am I missing something?thanks

1
Eric Fitz
3 years ago
U
User1154New Participant
asked in API & Webhooks
How to post action-messages to a conversation?

Intercom's agent chat interface has action messages that are displayed differently, i.e. in the center of the agent's chat window. For example the "You assigned this conversation to yourself 1h ago" notification. I would like to send this through the API, is this possible? Is there a conversation message type that we can use for this or recommended html body formatting type? I have tried applying the formatting that is applied in the agent's chat screen to my message body and this did not work.

6
R
Top Expert
3 years ago
U
User1154New Participant
asked in API & Webhooks
Intercom API does not respect office hours when conversations are created through the conversations API

When I create a conversation using the API, and run assignment for this conversation either using the run_assignment_rules route or just assign it to a department, this does not take into consideration the office hours. Is this an intercom API limitation or is there something I am missing in my workspace config?

2
U
3 years ago
A
AnandNew Participant
asked in API & Webhooks
I'm creating wallboard for my client where I have to show how many "total chat today"? How can I fetch that? Please help.

I'm creating wallboard for my client where I have to show how many "total chat today"? How can I fetch that? Please help.

6
A
3 years ago
K
Kevin G11New Participant
asked in API & Webhooks
Output when creating a conversation

The documentation for Creating a Conversation (sample response below) says that the ID representing the conversation is returned as a response. (conversation_id). However, when testing this, I'm only seeing the ID of the specific message - rather than the conversation_id of the conversation.... only type through message are returned. HTTP/1.1 200 OK{ "type": "user_message", "id": "2001", "created_at": 1401917202, "body" : "Hey, is the new thing in stock?", "message_type": "inapp", "conversation_id": "36000324324"} How can I find the ID of the conversation?   

3
R
Top Expert
3 years ago
U
User1061Connector
asked in API & Webhooks
We are creating conversations via the API to initiate a discussion thread with customer that are requesting a review of content they have submitted on our platform.

Currently, I add the "meta-data" of the content being reviewed as a note into the conversation. But it would be a lot better if I could move this into the sidebar. Is there a way to add meta-data into a conversation that is then automatically shown in the sidebar? Also it is a bit challenging since for various reasons customers might have multiple user IDs on intercom. We add all users (and their external ID) via Javascript on every request. But how do we best sync the intercom user ID back to our system, since the Intercom API always wants us to use their IDs and not our external IDs (which would be way more convenient).  Semi-related it is not very nice that we have to use IDs for things like teams and not just string identifier. This means we need to either fetch and cache this information or configure it, which is cumbersome, especially between the test and production intercom instances.

3
Eric Fitz
3 years ago
P
PavanNew Participant
asked in API & Webhooks
Why are my users having to reauthenticate?

We use Intercom's Oauth to get the access token for our users(Dashworks). Recently we are getting 401s and user's had to re login(Access token was changed). Do the token's expire by design and is there a way to refresh them?

4
Eric Fitz
3 years ago
T
Team C12New Participant
asked in API & Webhooks
webhook events for company and contact udpates

Hello Team, I am using intercom webhook events to process the changes to objects. However, there is no topic for contact.updated or company.updated, https://developers.intercom.com/building-apps/docs/webhook-model Without these topics, we have to run jobs to fetch the updates. Is there an alternate solution, or i am missing something

3
Eric Fitz
3 years ago
P
Priya NNew Participant
asked in API & Webhooks
contacts/search API sometimes does not return output for query filter ?

I am using contact/search API with query using created_at filter. My question is, when I query the record using created_at filter for newly created record and I am not getting records. but when I query the record using previous day UNIX timestamp for newly created_at record, I am able to get record or sometimes I am not able to get records on both scenarios Is there any issue on API side ? Below is my query Endpoint: https://api.intercom.io/contacts/search /p>method: POSTBODY -> JSON format{  "query":{        "field": "created_at",        "operator": "=",        "value": "1619049600"  }}  docs linkhttps://developers.intercom.com/intercom-api-reference/reference#search-for-contacts/p>

6
P
3 years ago
U
User1111New Participant
asked in API & Webhooks
Intercom API keeps returning User NOT FOUND error

I am trying to implement the Intercom API into my server side .NET Core application. I am using System.Net.Http Library to set this call up. The issue that I am running into is when I try to create a conversation using my code below I keep getting an error response stating "User Not Found" even though the same body being passed in works perfectly fine POSTMAN. Is there anything I am doing wrong here? ---------------------------------------------------------------------------------    public class Create   {       public FromObj From { get; set; }       public string Subject { get; set; }       public string Body { get; set; }   }    public class FromObj   {       public string Type { get; set; }       public string Id { get; set; }   } public async Task CreateConversationBlah()       {           using (var client = HttpClient)           {               client.DefaultRequestHeaders.Authorization =                   new AuthenticationHeaderValue("Bearer", "&lt

1
Eric Fitz
3 years ago
U
User1111New Participant
asked in API & Webhooks
How to add/update title to a conversation from the intercom api

So I have been following the document related to intercom api and was able to add a new conversation with body using the api. However, I am also trying to assign a conversation title along with some of my tags during the creation process but it does not seem to be reading those properties during creation. I tried the PUT endpoint after the conversation was created to update those fields but they do not seem to make any updates either. Please let me know what the correct way to accomplish this?! Thanks in advance.

4
U
3 years ago
A
Andrea CConnector
asked in API & Webhooks
Is it possible to change a contact's "external_id" via the API?

As far as I understand the "external_id" represent the "User id" we see in a user's or lead's profile.Is it possible to change a contact's "external_id" with a "PUT /contacts/<id>"?I tried but it doesn't seem to work. I can change other properties like "email" just fine, but "external_id" doesn't change in the contact model in the response to the call, despite the status code being "200 OK".Is there any other way to change the "user_id" of a contact otherwise?

13
R
Top Expert
3 years ago
Ask a question
Terms & ConditionsCookie settings