Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 489 Topics
  • 1,099 Replies
489 Topics
J
Jesse GNew Participant
asked in API & Webhooks
Why am I experiencing slow API response times?

I have been experiencing very slow API response times recently. Upwards of 10+ seconds and some never returning for both the list tags and search conversations endpoints. I checked the rate limit and seems to be plenty left, besides I do end up with a 200 response when it does eventually return. Not really sure whats going on so any guidance would be appreciated.

2921
A
Employee
2 years ago
U
User2309New Participant
asked in API & Webhooks
How to delete articles at once.

Is there a way to delete articles at once?I heard that you can delete the articles in bulk through api at once.Is there a team that has done that?

392
U
2 years ago
M
Murali KNew Participant
asked in API & Webhooks
What is the maximum size of the body in the conversation reply endpoint?

Regarding this endpoint - https://developers.intercom.com/intercom-api-reference/reference/reply-to-a-conversationIs there a limit to the size for body? If there is, what is that limit? We want to be able to send a transcript of previous conversations to the agent but we were wondering if there is limit to the length of the body that we can send in the payload in a single call.

2441
Eric Fitz
Employee
2 years ago
M
Morten NNew Participant
posted in API & Webhooks
Message export through the unstable API: How to include Sender?

Hi. I am using the unstable version of the API to export all messages sent in a given timeframe.Reference: https://developers.intercom.com/intercom-api-reference/v0/reference/downloading-the-data I wonder why Sender is not included in the exported data?How to retrieve that information? My best guess is that I have to use the ConversationID returned from the exported message data to retrieve information on the conversation as per:https://developers.intercom.com/intercom-api-reference/v0/reference/conversation-modeland then use the author from the source object. Is that correct? Thanks in advance.  

121
Eric Fitz
Employee
2 years ago
M
MykhayloActive User
asked in API & Webhooks
Labels For Custom Attributes in UI

Despite there is a dedicated property in data attribute object model, called 'label' which is supposed to provide a value for the custom attribute to be displayed in UI, looks it does not work. Even after I send a request to create a new property with some name in 'label' field, a property will be shown just as specified in 'name' attribute, with first letter capitalized. For example, if name=myCustomProp and label=My Custom Prop, then in UI it comes as 'Mycustomprop'. This is just not quite user friendly... https://www.intercom.com/help/en/articles/320-tracking-user-data-in-intercom

1334
D
2 years ago
U
User2280New Participant
asked in API & Webhooks
I don't understand how I can add a location when I create a lead. And is it possible?

Here is my request body:{ "email": "test@gmail.com", "role": "lead", "name": "First_name Second_name", "created_at": "123123123", "custom_attributes": { "Plan": "Plus", "Facebook": "https://facebook.comquot; } } 

121
L
Employee
2 years ago
M
Marco PNew Participant
asked in API & Webhooks
Have webhooks been updated to unsubscribe contacts from subscription types?

Have webhooks been updated to the subscription types feature? I need to synchronize my app with subscription preferences expressed by the users. I'm currently using user.unsubscribed webhook to keep track of cancelling subscriptions from emails link, but now I've been asked by the product team to update our outbound to different subscription types, therefore I need a more specific notification. Is this webhook already implemented? Thanks

503
A
2 years ago
A
Anurag MConnector
asked in API & Webhooks
Search admin or teammate by email?

I have a scenario where I need to check wether the admin with a particular email exists then, assign a conversation to him. So, I want to check if an admin exists with that email.But as per API doc, I am unable to find any good api to do so, instead I have to hit Get All admins, and the filter the admin from it. Is it expected or any better solution?

211
A
Employee
2 years ago
U
User2226New Participant
asked in API & Webhooks
API-created in-app - how do I choose badge or snippet?

Is there any way to create a conversation with delivery option of badge or snipped?I couldn't find something in the API docs.

542
Eric Fitz
Employee
2 years ago
A
Alex E11New Participant
asked in API & Webhooks
[Improvement] Allow the Intercom JS API to bubble exceptions up to the caller

I have a small piece of JS that attaches itself to anchor elements that link to an Intercom Article. When these anchors are clicked I intercept the event and call the `Intercom( 'showArticle', articleId )` API method. This works as expected. However, in local testing with a test environment those Article ID's are obviously not present. As expected, this fails and throws some errors in the console. This got me thinking about providing graceful fallback. Would it be possible to bubble these exceptions up to the caller so that I could catch and handle appropriately? In this case I would open the anchors link as if nothing happened. The goal here is to know about a failure with Intercom and have the opportunity to provide a graceful alternative for the user. This could mean that developers will need to handle exceptions bubbling from the API calls, a potentially disruptive change. Or, some kind of callback argument that can receive an error.

651
L
Employee
2 years ago
U
User2226New Participant
asked in API & Webhooks
Get event which triggered a conversation

Hey there, I created a transactional message from an event and I would like to get the events custom data in my webhook, once the user answered to the conversation. From the api I don't see any way to get the event which triggered the conversation. Can you help me out here?Another option would be to listen for created events and trigger the conversation myself and add the meta data from the event as custom_attributes to the conversation. But how do I tell the API to send the conversation as snipped? Thanks upfront

522
U
2 years ago
T
Tech SNew Participant
asked in API & Webhooks
How do I export conversation attributes from Intercom to Gitlab?

Hi everyone, I would like to extract some conversations from intercom to gitlab through API. I could have most of the conversation information, but I can't get the information details in the right panel. What is the good endpoint to use ? Regards

322
T
2 years ago
A
Anton K11New Participant
asked in API & Webhooks
Delay between a web hook and API response returning correct data

We want to get different conversation stats when we receive a onAdminAssigned web hook. Since the statistics object is empty in the web hook payload itself, we have to make a REST request to api/conversations/{id} to get a full conversation payload.  We noticed that if we make this call immediately after getting a web hook, the statistics object will still be filled with zeroes. But if we wait for a couple of seconds before making that call, then we can get all the data we need. Could you pls provide an estimation of the delay (average and upper boundary) between a web hook being sent and the data being accessible via RES API? Is it possible to send conversation statistics in the web hook itself?

1253
A
Employee
2 years ago
U
User2218New Participant
asked in API & Webhooks
What is the Intercom API's rate limit?

What is the actual rate limit? In the api it says 1000 per minute but when i make an api call it only returns 500 as max limit. Is there a procedure to ask for more calls? Does webhooks count as calls?

4911
A
Employee
2 years ago
R
Ram NNew Participant
asked in API & Webhooks
Why is my email sending under review?

Keep getting this error: Email can't be sent right now as your app is being reviewed. We've emailed your app admin with more details. How to resolve this? error: when calling https://io.intercom.api/messages - Email can't be sent right now as your app is being reviewed. We've emailed your app admin with more details

1923
Milan
Expert User ✨
2 years ago
V
Vladimir ANew Participant
asked in API & Webhooks
How can I use search by topics of conversation using api?

Hi! For example. I've been trying to use query like this:data = { "query": { "field": "topics.topics.id", "operator": "=", "value": topic_id } }but there is a wrong search field. Is there any right search field for searching by topics?

411
L
Employee
2 years ago
R
Ram NNew Participant
asked in API & Webhooks
API Error when calling https://api.intercom.io/messages

I am making a call with this data: {  "message_type": "email",  "subject": "Hey",  "body": "Ponies, cute small horses or something more sinister?",  "template": "plain",  "from": {    "type": "admin",    "id": "61df30800add612e4d8e19dc"  },  "to": {    "type": "user",    "id": "61df30800add612e4d8e19dc"  }} and the response I get is as follows:{    "type": "error.list",    "request_id": "004ar6gmrkcj0msrhlg0",    "errors": [        {            "code": "not_found",            "message": "Resource Not Found"        }    ]} Can someone tell me why and what mistake I am making? Thanks Nat

1261
Milan
Expert User ✨
2 years ago
D
Dan P12Active User
asked in API & Webhooks
Initiate a conversation from an admin to a user

Hi I'm trying to do something that I thought should be simple, but am struggling to find a solution and was wondering if anyone had any suggestions? Ultimately what I want to be able to do is: When a user of my app takes a particular action in the app, I want to trigger a message to be sent from an admin to the user saying something like "Thanks for the submission, we're looking into it and will get back to you...". I also need this conversation to appear in the admin's inbox, essentially as a "ticket" that they need to work on and get back to the user at a later date. I can't use the /conversations API to create a convo from admin to user because that direction isn't supported. (Conversations can only be created in the other direction, user -> admin).   I get a little further with the /messages API. It allows you to send a message from an admin to a user but the problem is that it doesn't create a conversation so nothing shows up in the a

10838
Eric Fitz
Employee
2 years ago
D
Dimitris ANew Participant
asked in API & Webhooks
POST request for contact in company

Hello, I need to send a POST request with the intercom API and I'm not sure how to do it.  In particular, I need the contact id of the contact that has a specific company id (plus some other identifier that will help me pick the specific contact of the many that can exist in the company). I'm using this: https://developers.intercom.com/intercom-api-reference/reference/search-for-contacts/p> The question, therefore, is how do I do a POST query that queries not for a scalar as you would do to search eg for Minessota ("field": "location.region") but rather for a scalar within an array (as is the id within companies). Here's a typical (truncate) response I need to process: {  "type": "list",  "data": [    {      "type": "contact",      "id": "60a3b30b980bf6b7f155eb99",      "browser_language": "en",      "os": "OS X 10.15.7",      "location&quot

301
A
Employee
2 years ago
M
Mason TNew Participant
asked in API & Webhooks
Is it possible to get the user object and last login timestamp in a single GET request?

Hi friends - I work for a company that wants to gather admin names, their inbox status, and their last login data from the API. Last login is stored separately in event logs. Is it possible to get user object + last login in a single GET request? Basically, trying to simply the number of API calls we make. Making a call to the Admin is much better than making calls to both Admin + Event Audit Logs and doing surgery work to stitch those values together. Having Last Login data, account invited date, and account deleted date as properties of the user object would be very helpful.

302
M
2 years ago
U
User815New Participant
asked in API & Webhooks
Why can I no longer retrieve UTM information via Intercom's API?

Hello, We are using the intercom API and since the API has been upgraded to version 2, we are no longer able to retrieve data from UTMs linked to contacts (campaing / medium / source).Do you know why? Is an update planned?Thank you in advance for your feedback. Have a good day 👋

183
Eric Fitz
Employee
2 years ago
L
Luca TNew Participant
asked in API & Webhooks
Why are certain fields not coming through with integrating Intercom via Integromat?

Hi Everyone, I'm trying to automate intercom with my CRM but unfortunately all of the fields are not coming through. My automation guy has put together a video outlining the problem and would really appreciate it if someone could help. Could be something on our end or a bug with the API Video Is linked Below https://www.loom.com/share/4817e63d3ae549e6b6ee966dc581adde

432
Milan
Expert User ✨
2 years ago
U
User779New Participant
asked in API & Webhooks
How can I resolve CSP (Content Security Policy) issues with Intercom?

Trying to use intercom URL in iFrame, facing the error which says "ancestor violates the following Content Security Policy directive: "frame-ancestors 'self' " Need a solution to overcome this issue. Kindly help us to resolve this

6423
B
2 years ago
U
User2548New Participant
asked in API & Webhooks
How to use webhook to integrate Intercom with SurveyLab (create contact/email)?

Hi, I want to use webhook to integrate Intercom with SurveyLab. I need to create a contact (email) in SurveyLab each time a conversation in Intercom is closed. How can I do that?

243
Milan
Expert User ✨
2 years ago
M
Marie P11Connector
asked in API & Webhooks
Sending data from user in specific segment to zapier (and Delighted)

HelloWe are using Delighted to send our NPS sruvey, I would like to use Intercom to send more information in Deligthted. Does anyone know how to use Intercom and Zapier Webhook to create this trigger ? Thank you

121
A
Employee
2 years ago
Ask a question
Terms & ConditionsCookie settings