Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 488 Topics
  • 1,095 Replies
488 Topics
T
TimurConnector
asked in API & Webhooks
How to iterate paginated Contacts search results

RequestPOST https://api.intercom.io/contacts/search Accept:application/json Content-Type: application/json Intercom-Version: 2.4 Authorization: Bearer token   { "query": { "operator": "AND", "value": [ { "field": "email", "operator": "~", "value": "timur+1" } ] } }results in{ "type": "list", "data": [...], "total_count": 78, "pages": { "type": "pages", "next": { "page": 2, "starting_after": "Wy0xLCI1ZjIyYzQzZjkxMjU5NmY1MDNiMjA4ZWUiLDJd" }, "page": 1, "per_page": 50, "total_pages": 2 } }But next requestPOST https://api.intercom.io/contacts/search?starting_after=Wy0xLCI1ZjIyYzQzZjkxMjU5NmY1MDNiMjA4ZWUiLDJd Accept:application/json Content-Type: application/

2973
Racheal
Intercom Team
2 years ago
S
svc-devNew Participant
asked in API & Webhooks
When users authorizes the app and switch the region, do we get that information as part of callback?

I'm trying to create an app intergration using the oauth process. I see users can host their data in eu, us, or au regions. When users authorizes the app and switch the region, do we get that information as part of callback?

181
Daniel M15
Employee
2 years ago
S
ShivprasadNew Participant
asked in API & Webhooks
Hoe can i send html response in conversation reply

Hi,According to https://developers.intercom.com/intercom-api-reference/reference/reply-to-a-conversation it says "Notes accept some HTML formatting." I am using below html as <html> <body> <h4>Share screen recordings</h4><br>            <img src="{video_icon}" alt="no image">            <a href='{record_link}' style="margin-top:30px; text-align:center; display:block;" >Record your screen</a>   </body> </html> However the style part is missing in the output. Can some one guide me what limitation exists on HTML formatting. I wanted to post an app in the reply, but i do not see any rest api where i can embed App in the conversation reply. That's the reson i am posting html form of my app rather than canvas. Kindly let me know if this is possible 

3604
Z
2 years ago
J
Joshua WNew Participant
asked in API & Webhooks
How do I add intercom to an angular app

Followed the instructions, but don't see the blue bubble at the bottom right

20591
Daniel M15
Employee
2 years ago
A
AeronNew Participant
asked in API & Webhooks
Is there a way to get only a single field, or a specific list of fields back when querying an object?

 For example, if I want to just get the name of the company, or the date it was created back when I look up the ID? I know that in general I could just ignore the rest, but I'm trying to do this within a Custom Action, and I don't necessarily want to write the whole company object back to the Person I'm looking it up for. For context on why I'm doing this rather than associating that Person directly to the Company, I don't want to pollute my Companies with non-employees of said Company. However, I'd still like to be able to look up what Company they are requesting support for so that we can customize their experience when they are interacting with a bot.

411
Z
2 years ago
U
UnmuktNew Participant
asked in API & Webhooks
App Review process: Questions wrt oAuth and Webflow

Background: We are building an integration with Intercom for our Application suite. We want the O-Auth flow in Intercom enabled for our users. As we understand it, this would require us to go through the App Review process from Intercom.  Questions: 1. Can we change the oAuth URL before/after review?2. Can we change the webhook before/after review?3. We want the installation of our Intercom plugin only via our web app itself, how long can we have the app approved but unlisted on Intercom?4. Does Intercom need access to our webhook code to test, given that there is nothing else on our Intercom app? 

172
U
2 years ago
H
Hasnain ZNew Participant
asked in API & Webhooks
How to attach contacts to a new company? Unable to do so as the new company isn't accessible.

Created a new company:curl https://api.intercom.io/companies\ -X POST \ -H 'Authorization:Bearer <AuthToken>' \ -H 'Accept: application/json' \ -H 'Content-Type:application/json' -d ' { "name": "Test Company", "company_id": "18ac530", }'It was created successfully. Then used the Intercom generated id for it to attach it to a contact:$ curl https://api.intercom.io/contacts/62fe23da8c9c889b4c86b884/companies\ -X POST \ -H 'Authorization:Bearer <AuthToken>' \ -H 'Accept:application/json' -d '{ "id": <intercom_id for the company> }'Got an error, company not found. The docs say that a company must have at least 1 user to be listed and accessible. But this is a Catch-22 how am I supposed to add users if I am unable to access the company. To confirm, that my initial call to create the company was indeed successful, I ran this:curl \ -s https://api.intercom.io/com

1333
C
2 years ago
U
User1202New Participant
asked in API & Webhooks
Can i create canvas kit apps with google apps script?

hi, i am trying to create an intercom canvas kit, i create a url for initialize and submit flow on google apps script but it don't work well  this is my google apps script code  INITIALIZEfunction doPost(e) { var Json = JSON.parse(e.postData.contents); sendDataSocket(Json)   var CanvasBody = { "canvas": { "content": { "components": [ { "type": "button", "label": "Click ME!!!!", "style": "primary", "id": "url_button", "action": { "type": "submit" } }, ], }, }, };   return ContentService.createTextOutput(JSON.stringify(CanvasBody)).setMimeType(ContentService.MimeType.JSON); }SUBMITfunction doPost(e) { var Json = JSON.parse(e.postData.contents);   var CanvasBody = { "canvas": { "cont

662
U
2 years ago
M
MayankNew Participant
asked in API & Webhooks
Can we export data programmatically through an API for series emails?

Sync limitations Intercom doesn’t consider outbound messages without replies as conversations.We found that if an end-user doesn’t reply to outbound messages (such as emails, posts, or chats), we can’t fetch the conversation IDs because the REST API does not return them. As a result, we can’t sync these conversations to your destination.  I want to see who gets which outbound. When can we get ability to get this data programmatically? @Azure Radio 277​ 

471
Milan
Expert User ✨
2 years ago
A
AhumNew Participant
asked in API & Webhooks
Unable to update contact's 'language_override' value

Hi I'm trying to update 'language_override' value during the user preference update event, but I couldn't see any changes even after calling the APIs. Is there any other way to update the field? Thanks

491
Racheal
Intercom Team
2 years ago
U
User2459New Participant
asked in API & Webhooks
Intercom returns an app from a completely separate account to my page. Their appId does not appear in my code. The end result is that my intercom continuously switches between two different companies on the page.

Has anyone else had this problem? It's been 3 days and Intercom support still hasn't read any tickets, so I figured I'd ask the community here.  The injector script and boot code both call the right appId, but the scripts that get injected insert both the correct and the other company's appId.

131
Racheal
Intercom Team
2 years ago
T
TausifNew Participant
asked in API & Webhooks
Dynamic Canvas Kit

Hello There,Consider me new to the intercome and don't have an idea about even the basics of integration. I'm presenting the use case and seeking a solution for it. Once the user opens up the messenger, he will be shown up with a form that is generated through my server (it is not the same every time. It is based on some conditions). The form content is different for different users based on the logic on the server.The user clicks on a button on this form and the response is sent back to the server for some business decisions. So I'm confused with following thingsHow should my server be intimated when the user opens up a messenger (with the user detail)How can I send the UI back in form of JSONHow can I record the response back if a button in that UI is pressed The information available is in bits and pieces and I'm not able to find the end to end example.Looking forward for an end to end example do acheive the use case. Regards,

1891
Daniel M15
Employee
2 years ago
A
AshwinNew Participant
asked in API & Webhooks
What is the logic to create a conversation URL from the fields returned in the Intercom conversations API?

I have an Intercom app, and I am pulling conversations in to my local storage for my customers to run additional analysis on. I want to be able to link them back to the original conversation in their Intercom dashboard. I can't find documentation on the logic to construct a link back to the conversation. Can anyone help me find the right logic?

3691
Milan
Expert User ✨
2 years ago
A
AgustinNew Participant
asked in API & Webhooks
I am trying to get a full list of the users through the /contacts endpoint of the current version of the API, but I am only getting the leads and not the users. Is there a param I have to pass to the endpoint? I tried role: user, type: user but no lu

I am trying to get a full list of the users through the /contacts endpoint of the current version of the API, but I am only getting the leads and not the users. Is there a param I have to pass to the endpoint? I tried role: user, type: user but no luck.

2236
A
2 years ago
H
Henrik AActive User
asked in API & Webhooks
Is it possible to delete multiple contacts via the Intercom API?

Is it possible to delete multiple contacts via the Intercom API? The article here does not say anything to that affect https://developers.intercom.com/intercom-api-reference/v1.3/reference/delete-users/p>

1684
H
2 years ago
U
User2149Active User
asked in API & Webhooks
Hi, I'm looking for a way to automatically update the subject of a conversation, or add a note, based on an attribute when it enters a specific team inbox.

In our case, we have an attribute called "preferred_language" and a team inbox called "Repair Inbox".If a conversation would end up in the Repair Inbox and if the preferred_language of the customer would be "EN", then I would like to add a note or subject to the conversation saying "English Customer". Would be great if anyone could help me out or let me know if this is possible :)  Thanks!

3364
U
2 years ago
U
User1387New Participant
asked in API & Webhooks
Count of Tickets In a View/Team

Hello, I would like to be able to query a team to see how many tickets are in them at a given time. For example, we have an overnight queue and I would like to be able to alert on if that queue gets past a certain number.  Seems like I would want to add a tag using the rule and then query for tag count? Thanks!

2532
Z
2 years ago
J
Juan C13New Participant
asked in API & Webhooks
Hello, I'm trying to POST a new message pop up with postman but i'm not able to do it

As i said, i'm trying to POST a new intercom/message to my customer but i'm not able to do it. Maybe the body is not correct. I have no problems with 'intercom-client' node library but now I must send this information through a serverless function :P 

61
Racheal
Intercom Team
2 years ago
U
User2436New Participant
asked in API & Webhooks
Is there a way to get an API token for testing?

I want to try out the https://api.intercom.io/conversationsendpoints with demo data

3561
Racheal
Intercom Team
2 years ago
U
User164New Participant
asked in API & Webhooks
Is there an API to get the list of SLAs and their details?

Hello, We'd like to query via REST APIs all the Conversation SLAs for an account. We'd also like to know how much time is left/overdue with reference to an SLA for a single conversation. As of now, we can see that the conversational model has sla status but not details - https://developers.intercom.com/intercom-api-reference/reference/conversation-model/p> But, I don't seem to find a way to get the SLA details. Does Intercom provide a way to do that programatically? Regards

661
Racheal
Intercom Team
2 years ago
U
User2399New Participant
asked in API & Webhooks
How do I authenticate a request (e.g. initialize request) coming from a canvas kit app on our back end.

I created a canvas kit app for my teammates that looks up some customer details in our database and displays them in the inbox details panel, but I don't see any incoming data (like an access token) that I can use on our side to make sure the request is coming from intercom.

2882
U
2 years ago
T
TimoNew Participant
asked in API & Webhooks
Is there a way to set non-custom attributes of conversations via the API?

We would like to set the "Priority" or "SLA" attributes of conversations in particular. The reason is that we want to externalize the decision making of important vs non important conversations as soon as they come in. In the update conversation API, you can only update custom attributes. Right now we are only interested in Priority and SLA, but in the future we also might want to set tags or other fields. What we already tried: 1.Create an inbox rule that e.g. sets Priority if a custom attribute has a certain value. We set up a webhook to be notified when a new conversation comes in and set that custom attribute on the conversation through the API. Problem with this is that the inbox rule is triggered before we set the custom attribute. We also tried to call the /conversations/{id}/run_assignment_rules API but that only seems to trigger inbox rules which assign conversations. Even if we have an inbox rule that both assigns and sets the priority flag, only the assig

1151
Racheal
Intercom Team
2 years ago
E
EvgeniyaNew Participant
asked in API & Webhooks
How to connect a bot made on a different platform to Intercom

Hey everyone. I try to understand how I can connect a bot made on a different platform to the Intercom. Has anyone come across a similar case?

251
A
Employee
2 years ago
A
Anthony P11New Participant
asked in API & Webhooks
Hello everyone, I would like to know if I can list custom bots and resolution bots of my app by requesting the API. Thank's in advance.

Hello everyone, I would like to know if I can list custom bots and resolution bots of my app by requesting the API. Thank's in advance.

81
Racheal
Intercom Team
2 years ago
U
User1382New Participant
asked in API & Webhooks
Health Check: Why do we receive so view checks.

Hello everyone, our app (Coview) implemented the health check. Based on the following description from the documentation, we assumed that we would receive at least one call for each of the installations of our app each day: This will happen at least once a day for each workspace where the app is installed. With this information, we expect you to discover if the app is in a healthy state for this workspace and respond to the request telling us whether it's healthy, unhealthy, or you don't currently know.However, according to our logs we just a handful of checks each day although we have a few hundred installations. Do we misunderstand something here?

52
U
2 years ago
Ask a question
Terms & ConditionsCookie settings