Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 528 Topics
  • 1,199 Replies
527 Topics
T
Tsvetoslav VasevNew Participant
asked in API & Webhooks
Can't retireve articles with articles API

Hi, We have some set of tool which fetch an article by id. Recently it worked, however after the move of articles to knowledge hub i cant retire a single articles withcurl -i -X GET 'https://api.intercom.io/article/{articleId}' \ -H 'Authorization: Bearer <secret>' \ -H 'Intercom-Version: 2.11'.However we can fetch all articles with api.intercom.io/articles, so maybe something has changed.All help would be greatly appreciated.

683
Jacques Reynolds
Intercom Team
D
darshanhiranandaniNew Participant
asked in API & Webhooks
Darshan Hiranandani : How to Link and Retrieve Company Information in Intercom Tickets?

Hello everyone,I’m Darshan Hiranandani, We're currently working on implementing a ticketing and ticket portal system, and we're looking to import customer tickets from another provider into Intercom. While we've successfully been able to create tickets using the API, we are running into a challenge when it comes to linking a company to a ticket.Currently, an admin can manually link a company to a ticket in the inbox, but we haven’t found a way to make this step mandatory. This is an issue because without a linked company, the customer won't be able to access the ticket via the portal, though they can still see it through the messenger. We want to avoid confusion in this regard.We also have trouble retrieving the company linked to a specific ticket using the GET /tickets/{id} endpoint.This leads to the following questions:Is there a way to link a company to a ticket programmatically through the API? Can we retrieve the linked company information through the API? How can we enforce the c

331
mateusz.leszkiewicz
Intercom Team
G
Glen CocoNew Participant
asked in API & Webhooks
how do i update relationship attributes between intercom objects?

I’m referencing this API documentation https://developers.intercom.com/docs/references/unstable/rest-api/api.intercom.io/data-attributes/updatedataattribute for updating data attributes -1. is it possible to use APIs to update relationship attributes between different standard intercom objects (contact, conversation, ticket)?2. is it possible to use APIs to update relationship attributes between standard intercom objects (e.g. contact) and custom objects?

341
Jacques Reynolds
Intercom Team
G
Glen CocoNew Participant
asked in API & Webhooks
unstable intercom api question: what's the eta on being able to list data attributes on custom objects?

I’m using the unstable version of the api to see if i can list data attributes on custom objects and doesn’t seem like this is possible.  When will this be allowed? {"type": "error.list","request_id": "001g71vtd1equmb5qab0","errors": [{"code": "parameter_invalid","message": "unsupported model parameter [campaign]"}]}

211
E
Intercom Team
A
Antal KissNew Participant
asked in API & Webhooks
`Sometimes getting "User Not Found" (404) error when sending events however user was created years ago

Hi there,we’ve recently added events tracking and it was noticed that we get ad hock "User Not Found" error however user exists years. Request we send:{  "event_name": "post_autopublished",  "created_at": 1731959712,  "user_id": "..."} Response we received:{  "type": "error.list",  "request_id": "0045a0lc51qku6vpphg0",  "errors": [    {      "code": "not_found",      "message": "User Not Found"    }  ]} Retrying the API call can work but would be great to know what causes the issue. Any help would be appriciated. Best,Antal

1514
A
D
DavidChapmanNew Participant
asked in API & Webhooks
Tickets Search API Call Does Not Return All Tickets

There seems to be an issue with the Intercom API. I'm using the tickets/search POST call and it's only retrieving 97 of my 225 tracker tickets.POST: https://api.intercom.io/tickets/searchThe body of my API call looks like this:{"query": {"operator": "AND","value": [{"field": "open","operator": "=","value": true},{"field": "ticket_type_id","operator": "=","value": 2}]},"pagination": {"per_page": 100}} I also tried:{"query": {"operator": "AND","value": [{"field": "open","operator": "=","value": true},{"field": "ticket_type_id","operator": "=","value": 2}]},"pagination": {"per_page": 100}}

502
bernice
Intercom Team
A
AndriiNew Participant
asked in API & Webhooks
Conversation API, different filters

Good day. Could you please advise how to download conversations by filtering them based on workspaces, views, agent, tags, and closed status? I tried filtering by workspaces and views, but I couldn't find how to do it.

412
Nur Nahid
Super User ✨
H
Hide KojimaNew Participant
asked in API & Webhooks
Hitting the Enter key while entering Japanese text with IME mistakenly sends the unfinished text to chat.

While I’m typing Japanese text with IME (Input Method Editor)  If I hit enter here, I expect it to finalize the Japanese text with IME BUT not sent it as a chat message yet. But this widget sent the unfinished text any way.

1585
S
K
Keyman Letter CSチームNew Participant
asked in API & Webhooks
When entering Japanese text with an IME, pressing the Enter key mistakenly sends the incomplete text to chat.

When entering Japanese text with an IME, pressing the Enter key mistakenly sends the incomplete text to chat. If I press Enter here, I anticipate finalizing the Japanese text with the IME, but not sending it as a chat message yet. However, this widget still sends the unfinished text anyway.

404
S
H
HirokiNew Participant
asked in API & Webhooks
How to upload image with Rest API

I want to create an article and upload an image on it with API but I don’t know how.I can create an article with title and main text so far.I think Intercom has hosting service and can store attachments and upload from it, but it looks like there is no such service.How can I upload image or attachment with Rest API?If you have an idea, please tell me.

902
H
D
darshanhiranandani1New Participant
asked in API & Webhooks
Darshan Hiranandani : Looking for a Solution to Bulk Create/Update Users in Intercom via API

Hello everyone,I’m Darshan Hiranandani, working on an application that has thousands of users, and I need to regularly create and update these users in Intercom, at least once a week. The problem is that the current Contacts API doesn't fully support bulk updates and comes with some significant limitations:It requires my app to track whether a contact already exists before performing a POST or PUT request. The API rate limits are very restrictive, especially for medium-sized user bases (166 requests per 10 seconds). It also requires storing the Intercom ID for updates, which isn’t ideal since my app uses an external ID for users. Additionally, the manual import process requires mapping each attribute, which is cumbersome and prone to errors.Given these constraints, I’m looking for a better approach or solution to enable bulk creation and updating of users in Intercom. Has anyone worked around these issues or found a better solution for handling bulk user operations?Would love to hear y

561
Nathan Sudds
Top Expert ✨
K
Krish PatelNew Participant
asked in API & Webhooks
Intercom API - Can not create lead with custom external_id AND can not update lead to have custom external_id

https://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/createcontacthttps://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/updatecontact I am unable to figure out why this is happening and on the API documentation says it should be able to update the value.

241
Jacques Reynolds
Intercom Team
M
Mukhammed KairatulyNew Participant
asked in API & Webhooks
Can't create a new user using REST API

Hello!I am trying to create a user by using the API endpoint described here:https://developers.intercom.com/docs/references/1.0/rest-api/users/create-or-update-userThis is the cURL that I am using: curl -X POST https://api.intercom.io/users -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '{"user_id":"3ba5cb8d-8d66-4887-8d1b-4a9b66031f90"}'It throws this error: { "errors": [ { "code": "media_type_not_acceptable", "message": "The Accept header should send a media type of application/json" } ], "type": "error.list"}After that, I add the Accept header and now I get this error no matter what I send:curl -X POST https://api.intercom.io/users -H "Authorization: Bearer <token>" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"id":"3ba5cb8d-8d66-4887-8d1b-4a9b66031f90","user_id":"3ba5cb8d-8d66-4887-8d1b-4a9b66031f90"}' { "errors": [ { "code": "not_found", "message": "The requested res

1091
Jacques Reynolds
Intercom Team
B
Ben HizakActive User
asked in API & Webhooks
api does not paginate (/contacts)

Hi,I am using the intercom API list all contacts (endpoing /contacts)The API call responds as expcted with two problems:it ignores the per_page parameter. I tried 1, 5, 11 and other values. It does not paginate, ignoring the starting_after parameter. In the screenshot below please notice that pages.next.starting_after that was returned is the same was as was sent. I tried different API versions, including 2.11 and unstable Postman Screenshot 

707
B
A
AndresNew Participant
asked in API & Webhooks
API Issue with contacts/search endpoint

Hello, I'm trying to search for a contact using contacts/search endpoints my request is     "query": {                "field": "email",                "operator": "=",                "value": email,            }, This is working when testing in your site https://developers.intercom.com/docs/references/rest-api/api.intercom.io/contacts/searchcontacts. But when I try to do it on my codebase I receive this error Error with Intercom request for org 362 -- Response from url: https://api.intercom.io/contacts/search is status: 500, message: {"type":"error.list","request_id":"0044dun34918mvul4n10","errors":[{"code":"server_error","message":"Server Error"}]} do you know what could be wrong? Thanks

252
mateusz.leszkiewicz
Intercom Team
C
Corrie Hermans-WebsterConnector
asked in API & Webhooks
How can I block specific users from being counted towards my MAU/ Blacklist domains

We create a lot of test accounts to test things in our app that have absolutely nothing to do with Intercom. However, every single one of these test accounts counts towards our MAU in Intercom. Has anyone created a custom code or other workaround to block these users from showing up at all? I previously asked support if there was anything and they said I would have to build this myself. We have a test environment, but these test accounts occur on our production environment as well.  Honestly, it is very upsetting since I know competitors allow you to blacklist certain domains within your settings so none of your data is disrupted by your internal tests. 

3134
D
D
Diego RNew Participant
asked in API & Webhooks
How can we use custom templates when sending emails from intercom through the API? (Read details for more)

Hi!We are integrating the Intercom API in order to send email messages to our users from our App, and we're already being able to send them, being received, checking the seen status, etc..., ​We would like to use a custom template when sending our emails, but we're not able to achieve that.We've trying creating a new template, and when sending the email from the intercom page, it works (email is received with our custom style) but when sending through the API, we can just select plain or personal, but in both cases, the standard style is applied.We're not aiming to do anything really special, just using some custom Google fonts and customising the colours of the buttons. Thanks a lot in advance. Cheers,Diego.

6147
O
R
reniel89New Participant
posted in API & Webhooks
Setting Up a Webhook for Admin Replies in Intercom (Expo Integration)

Hello! Could someone please guide me through setting up a webhook that triggers when an admin replies to a user?We’ve already integrated Intercom into our mobile app using Expo, and I’d like to run an event handler each time an admin responds to a user message. Any step-by-step instructions or advice would be greatly appreciated.Thank you in advance!

481
Emilygav
Intercom Team
P
patrickforeceptsNew Participant
asked in API & Webhooks
Retrieve Proactive Support Message Content in webhook

Hi,We have a use case where our intercom user creates a message (eg chat) to be sent to all leads, and would like the message content to be picked up by our webhook endpoint upon sending the message, so that we can forward that message to external APIs.We are able to get a notification event whenever the message is sent by subscribing to the content_stat.chat topic in the webhook settings, but this topic only has the statuses of the message sent, but not the actual message content itself.We’ve tried subscribing to the following topics, but I don’t see it working for our use case:conversation.admin.opened     conversation.admin.replied     conversation.admin.single.created     conversation.user.created     conversation.user.repliedAppreciate if anyone has any insight on how we can get it to work. I’ve considered the possibility of a custom action but there does not seem to be anywhere that a proactive support message can configure such an action into it. Many thanks in advance.

1012
D
A
Abdul rNew Participant
asked in API & Webhooks
Is there a way to add a custom_attribute to conversation via API ?

I want to add a custom_attribute to conversation via API, But not able to add custom_attribute to conversation

2672
I
K
Krish PatelNew Participant
asked in API & Webhooks
Intercom API - Reply ticket attachments

The attachments that are upload through the browser are working fine as seen in the image and json file attached (red sample label image)But attachments that are uploaded and attached to replies are not working as expected. The files are uploaded correctly and are attached to the tickets parts (id 265 and 266). If we visit the file url then the image works correctly. But on the browser the images are not showing up (as seen in the screenshot).I am unsure what I am doing wrong?{ "type": "ticket", "id": "70", "ticket_id": "11", "ticket_attributes": { "_default_title_": "examplecompany@verun.com", "_default_description_": "@Services:\nBuilding & Property Wash\n-\n@Rooms:\n\n-\n@Message:\nasdfasdf" }, "ticket_state": { "type": "ticket_state", "id": "1", "category": "submitted", "internal_label": "Submitted", "external_label": "Submitted" }, "ticket_type": { "type": "ticket_type", "id": "5", "name": "Job", "description": "Job", "icon": "👷",

682
K
R
robin.nguyenNew Participant
asked in API & Webhooks
Help to get delivery status of conversation

Hi there,I am trying to get the delivery status of a conversation (ex : delivery, undelivered). I tried using the retrieve a conversation API, but there isn't any field referring to delivery status.https://developers.intercom.com/docs/references/rest-api/api.intercom.io/conversations/retrieveconversationCould someone please help me with how to get delivery status via API or Webhook?Thanks.

311
bernice
Intercom Team
Eduardo Soares Azzolin
Eduardo Soares AzzolinNew Participant
asked in API & Webhooks
Historical statistics on articles via API

Hello, everyone, is there a way to export detailed historical statistics of articles like the screenshot with the API? I found the Retrieve an Article endpoint, but it only returns the current cummulative statistics.  

292
Eduardo Soares Azzolin
O
Ocean WiseNew Participant
asked in API & Webhooks
Can I retrieve articles from api by tag?

Intercom ui allows me to add tags to articles and filter articles by those tags but as far as I can see there is no such functionality on the API? Can it be done? 

1063
E
Intercom Team
Andrii Fedyk
Andrii FedykConnector
asked in API & Webhooks
How to receive webhooks with FIN replies

Hello, I have an integration which listen for admin’s reply to the conversations. When admin sent reply the service receive conversation.admin.assigned webhook. When I assign chat to Fin, I see on app.intercom.com that Fin sent a message to the chat, but I don’t see a related webhooks in the logs.Is there dedicated topic for Fin replies?

5158
mateusz.leszkiewicz
Intercom Team
Ask a question
Terms & ConditionsCookie settings