Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 466 Topics
  • 1,060 Replies
466 Topics
M
marcosNew Participant
asked in API & Webhooks
Webhook content_state chat event weird behavior

Hello, since we are using our own notifications implementation using AWS amplify, we currently rely on the webhook to send Intercom notifications for our users. To send a push notification when creating a new chat message trough Proactive support we listen for the 'content_stat.chat' topic and stat_type: 'receipt'. However, for some users this event is only sent when they open the app, for other users (so far I could only make it work for one at a time) this event is sent even when they have the app on the background (which is the behavior I want). What is the behavior of this event, and how can I make it work for multiple users at the same time? I don’t want them to have the app open for this notification to arrive.If listening for this event is not a reliable way of sending push notifications when chat messages are sent, is there any alternative way of making Intercom Notifications work alongside amplify notifications?

1
E
2 months ago
A
Alexandra PActive User
asked in API & Webhooks
The session_count attribute is missing from the Contact object

It seems that in v2 when the User and Lead models have been merged into Contacts, the session_count attribute has been removed from the response.  The Company object displays the session_count information so I'm wondering if there's a specific reason why the user session_count has been removed or if it's just a slip?

7
R
2 months ago
R
Rodrigo SampaioNew Participant
asked in API & Webhooks
Error adding a tag to a user

I’m trying to add tags to users via APi but is not working, Are there any diferences between contacts and users?I tryed using both and was not sucessful.I’m doing this http request but nothing is happening to the user tag  

2
H
2 months ago
A
AlexRNew Participant
asked in API & Webhooks
Did the webhook body change for a first message?

I think the webhook body has changed when a user sends a message,For the first message a user sends, I see the below. The body used to have the user’s message, but now it’s null. Also it’s a new part_type `language_detection_details`Anyone else notice this? "conversation_parts": { "type": "conversation_part.list", "conversation_parts": [ { "type": "conversation_part", "id": "2322", "part_type": "language_detection_details", "body": null, "created_at": 1718102859, "updated_at": 1718102859, "notified_at": 1718102859, "assigned_to": null, "author": { "id": "7189586", "type": "bot", "name": "Fin AI", "email": "operator+wed4314z@intercom.io" }, "attachments": [], "external_id": null, "redacted": false } ], "total_count": 1 } } }

1
C
3 months ago
V
Vitalii SmolNew Participant
asked in API & Webhooks
Issue with translated_content after upgrading from API version 2.3 to 2.11

Hi everyone,I've recently upgraded from Intercom API version 2.3 to 2.11 and I'm encountering some issues. I understand that sections are now deprecated and are accessed via collections. I'm able to update the section names using the new path help_center/collections/{id}.However, when I try to use translated_content, I receive the following error:{ "type": "error.list", "request_id": "0001t87jrm46e5t3rtp0", "errors": [ { "code": "not_found", "message": "Resource Not Found" } ]} Has anyone else experienced this issue or can provide guidance on how to correctly use translated_content in version 2.11? Any examples, workarounds, or documentation links would be highly appreciated.Thanks in advance for your help! 

2
bernice
3 months ago
B
Ben PerlNew Participant
asked in API & Webhooks
How can I integrate my Intercom contacts with my web app's database?

Title + I understand I have to use the Intercom API somehow, but I'd like a little more guidance.

1
Nathan Sudds
Top Expert
3 months ago
B
BaptisteCoquelleNew Participant
asked in API & Webhooks
Adding Vimeo + Intercom Iframe on an article by API

Hi there!Going crazy over here. Trying to add a Vimeo iframe to my article by API.When it’s youtube, it works fine, but with Vimeo - no matter the URL I choose I always get “video src not supported”.The article creation works well and I am just trying to add a vimeo iframe to it.here is a fake video I created an uploaded This will not pass API validation “video src not supported” (but will work if I add it from the UI): <iframe src="https://player.vimeo.com/video/956950834?h=adfcdc69e8"></iframe> This will pass API validation but the URL is missing the h parameter and Vimeo cannot read: <iframe src="https://player.vimeo.com/video/956950834"></iframe>What can I do? I also tried multiple version of the vimeo URL - no luck.Let me know!

1
Nathan Sudds
Top Expert
3 months ago
T
Tom StrattonNew Participant
asked in API & Webhooks
How to add formatting to Conversation notes via API

I’m writing a helper app that adds notes to conversations and would like to be able to format the contents.Basis HTML seems to work OK but I’d like to add a code block and a table and neither are well supported. Can anyone point me at the correct documentation or provide other guidance?

6
P
3 months ago
R
RolfConnector
asked in API & Webhooks
Is it possible to find exactly one contact by their External ID or call DELETE on exactly one contact by their External ID?

Having to first search by External ID, then grab the correct Intercom-provided User ID and then calling DELETE seems like a lot of steps to be able to delete someone when you already know the External ID. Is there a better way? Can a better way be made? Doing one call to delete a contact's data instead of three would benefit Intercom too, right? 

9
O
3 months ago
A
adityakanadeNew Participant
asked in API & Webhooks
Issues with Webhook Authorization for OAuth Integration

Description:I am encountering issues while integrating Intercom webhooks using OAuth. Although the OAuth flow works and I can obtain access tokens, I am unable to create webhooks due to unauthorized token issues. I have selected all  available scopes in the Intercom Developer console, but the issue persists.Error: {  "type": "error.list",  "requestid": "003avbbpvjpgktcsppvg",  "errors": [    {      "code": "token_unauthorized",      "message": "Not authorized to access resource"    }  ]}How To Reproduce:Request URL / Headers:  URL:  POST https://api.intercom.io/subscriptions Headers: Authorization: Bearer <access_token> Authentication method or app type: OAuth 2.0 errors: token_unauthorized: Not authorized to access resourceLet me know if you need any additional details.Could you please assist in resolving this issue so that I can successfully create webhooks?Thank you for your support.

1
mateusz.leszkiewicz
3 months ago
D
dev-moNew Participant
asked in API & Webhooks
@intercom/messenger-js-sdk with React

We are trying to use official @intercom/messenger-js-sdk with our react app.https://www.npmjs.com/package/@intercom/messenger-js-sdkWe are calling Intercom instance in our App component Intercom({ app_id: ..., });and then updating user info when user data is available using following functions:import { boot, shutdown, update } from "@intercom/messenger-js-sdk"; when there is no user data we are calling boot with only id,boot({    "app_id": "...",})and if there is user data, we are passing required properties to boot functionboot({    "app_id": "...",    "user_id": "...",    "name": "...",    "email": "...@......",    "created_at": ....,}) It seems that when calling with boot({ "app_id": "..."}), user data is not cleared and in chat we continue to receive messages as if user is still logged in.Once boot() is called with user data, can it be rebooted with no data (for example, in scenario if user is logged out from our app and we want new chat instance without user data)? Also, if t

1
C
3 months ago
D
darshanhiranandaniNew Participant
asked in API & Webhooks
Darshan Hiranandani - How does the API handle large datasets when performing bulk user operations?

Hi, I’m Darshan Hiranandani, How does the API handle large datasets when performing bulk user operations? Are there any specific mechanisms or best practices in place to ensure efficient processing and minimal performance impact? Have anyone any suggestion and idea please share.  

1
C
3 months ago
J
Joe L11New Participant
asked in API & Webhooks
Unable lto save topics in webhook

I’m trying to create notifications for conversations initiated and/or replied by users. However, I am unable to save the webhook with the selected topic(s). I see a popup that says “Your webhook settings were successfully updated and a test request was sent successfully” but the topics are not saved to the webhook.

2
aykut.aydin
3 months ago
S
story allenNew Participant
asked in API & Webhooks
How do I get a reply when I send a message using the api?

I send a message user the api: Reply to a conversation,How do I get reply when customer reply ?I need to subscribe conversation.admin.replied  this topic ?

1
aykut.aydin
3 months ago
T
Tereza ZaloniNew Participant
asked in API & Webhooks
Data Accessibility Challenges: Custom Object Attributes

Hello everyone,Our team, operating within the travel industry, heavily rely on API calls to extract valuable insights from our database (e.g. departure dates, company codes, destinations etc.) wihin Intercom workflows. We then save this information as custom object attributes.This setup was designed to facilitate detailed data analysis of our workload while saving our team time by automating the input process for each request.However, to our surprise, custom object attributes are not accessible through search, reporting, or exporting functions within Intercom. As a result, despite the data residing in Intercom, our team still needs to manually input it into conversation and people data to make it available for reporting and exports.Recognizing the significance of this time-consuming process, we're actively seeking a solution to automate it.Is it feasible to complete conversation and people attributes via an API call (bypassing reference option), or are there alternative workarounds to

1
mateusz.leszkiewicz
3 months ago
T
Tereza ZaloniNew Participant
posted in API & Webhooks
Data Accessibility Challenges: Custom Object Attributes

Hello everyone,Our team, operating within the travel industry, heavily rely on API calls to extract valuable insights from our database (e.g. departure dates, company codes, destinations etc.) wihin Intercom workflows. We then save this information as custom object attributes.This setup was designed to facilitate detailed data analysis of our workload while saving our team time by automating the input process for each request.However, to our surprise, custom object attributes are not accessible through search, reporting, or exporting functions within Intercom. As a result, despite the data residing in Intercom, our team still needs to manually input it into conversation and people data to make it available for reporting and exports.Recognizing the significance of this time-consuming process, we're actively seeking a solution to automate it.Is it feasible to complete conversation and people attributes via an API call (bypassing reference option), or are there alternative workarounds to

0
T
4 months ago
T
Tereza ZaloniNew Participant
posted in API & Webhooks
Data Accessibility Challenges: Custom Object Attributes

Hello everyone,Our team, operating within the travel industry, heavily rely on API calls to extract valuable insights from our database (e.g. departure dates, company codes, destinations etc.) wihin Intercom workflows. We then save this information as custom object attributes.This setup was designed to facilitate detailed data analysis of our workload while saving our team time by automating the input process for each request.However, to our surprise, custom object attributes are not accessible through search, reporting, or exporting functions within Intercom. As a result, despite the data residing in Intercom, our team still needs to manually input it into conversation and people data to make it available for reporting and exports.Recognizing the significance of this time-consuming process, we're actively seeking a solution to automate it.Is it feasible to complete conversation and people attributes via an API call (bypassing reference option), or are there alternative workarounds to

0
T
4 months ago
Ö
Ömer Gökçe TümerNew Participant
asked in API & Webhooks
Getting event when receiving proactive support message

Hello,we are trying to implement a custom launcher that uses intercom’s launcher inside of it as one of our options. Everything went smoothly until we saw that our proactive support messages were showing without our launcher noticing. We couldn’t find any event to get triggered in our code when the user receives a proactive support message. Is there any way of achieving this? we tried with the “onShow” event but that one only triggers when the intercom launcher is opened manually and not through a proactive support message.Thanks in advance!

1
mateusz.leszkiewicz
4 months ago
A
Alejandro NarmonaConnector
asked in API & Webhooks
Workflow is not triggered when creating Messages/Conversations through the API

Hi All, I’ve a contact form on the web, and in Intercom we created a Email workflow, if some email is send to a email address we trigger the email workflow. So, I need to trigger that workflow when I POST  a Conversation o Message, with message_type = email. I’ve tried POST conversations, POST message, also set the from and to with valid contacts/users, the message/conversation is created but the workflow is not triggered. Any ideas?

2
A
4 months ago
J
Johan ONew Participant
asked in API & Webhooks
How do I trigger events on company level

Hi, I'm a little new to intercom but would like to work wtih it in a very technical automated way. We would like to be able to insert events that happen on the company level, and then trigger some emails / notifications to specific types of users (eg has ADMIN label) based on that event happening.  So for example:  Company onboards in our own system with a number of usersWe create the company entity in intercomWe create the user entities in intercom and associate them with the companyWe throw an event to intercom that the company "has_been_onboarded"Intercom rules pick up the event and send emails only to ADMIN users that welcomes them to our service So here the event is on the company level, but it should trigger an email to specific types of users within the company. Is this possible? A few quick tips & pointers would be really appreciated! /Johan

4
U
4 months ago
F
Fabian DittrichNew Participant
asked in API & Webhooks
https://api.intercom.io/companies/list not working

Hi,  Using the “/companies” with scroll parameters works without problems. Somehow though I need a way to read companies starting with the most recently added, and it seems “companies/list” is the only way to do that.  No matter how I query “companies/list”, no matter what parameters I set for page, per_page and  order I always get this same error:{"type"=>"error.list", "request_id"=>"003kmpu8u10s0f0dgeb0", "errors"=>[{"code"=>"company_not_found", "message"=>"Company Not Found"}]} Can you advise?

1
mateusz.leszkiewicz
4 months ago
T
thisisntjonNew Participant
asked in API & Webhooks
Help Setting Up SMS Alerts for VIP Calls Using Intercom

Hello,I’m trying to set up an SMS alert system in Intercom for when a VIP customer calls in. The plan is to use the phone workflow to trigger an API call, which then triggers an event. This event should prompt an SMS to be sent to a specific segment of our team.I've been attempting to use "Last contacted" for the created_at field and "Contact ID" for user_id in my API setup, but I keep encountering JSON format errors. If anyone has experience with setting up similar workflows or can offer insights into what might be going wrong, I'd greatly appreciate your help. Also, if there's a different approach that could achieve the same outcome, I’m open to suggestions!Thanks in advance for your assistance!

1
mateusz.leszkiewicz
4 months ago
K
kmchucNew Participant
asked in API & Webhooks
Unable to POST Contact using email

I’m currently trying to POST a Contact with just an email, and am currently being met with a 400 error:Request body:{"name": "Kim Chuc", "email": "email@gmail.com"}Response body:{ "type": "error.list", "request_id": "0004n8c4t4e6a3olv82g", "errors": [ { "code": "invalid_document", "message": "either_email_or_user_id_present validation failed" } ]} Based on the docs, email is the only required field to POST a Contact and I’ve double checked to make sure the email doesn’t already exist: Has anyone ever come across this issue before? 

1
Jacob Cox
4 months ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks
How to get id of lead merged to user

The REST API has a method for merging contacts from lead to user. It works pretty simple:```curl -i -X POST https://api.intercom.io/contacts/merge \  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \  -H 'Content-Type: application/json' \  -H 'Intercom-Version: 2.10' \  -d '{ "from": "LEAD_ID", "into": "USED_ID" }'```Also, lead can be merged to user in the Intercom app. When lead is merged, our integration listen for webhook with topic `contact.merged`. This webhook has an information to what contact the lead was merged, but has a missing part from what lead: ```{ "type": "notification_event", "app_id": "abcdee", "data": { "type": "notification_event_data", "item": { "type": "contact", "id": "USER_ID", "workspace_id": "abcdee", "...": "..." } }, "links": {}, "topic": "contact.merged", "delivery_status": "pending", "delivery_attempts": 1, "delivered_at": 0, "first_sent_at": 1713533523, "created_at": 1713533523, "self": null}``` May you add lea

1
E
4 months ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks
How to get information about Article in message?

When admin replies with an article, webhook does not contain details about it. May we have a link to article in webhooks? 

2
E
4 months ago
Ask a question
Terms & ConditionsCookie settings