Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 487 Topics
  • 1,093 Replies
487 Topics
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.

40
H
3 hours ago
S
Shraddha ANew Participant
asked in API & Webhooks
Can we get list of all articles in a collection using the REST API?

Can we get list of all articles in a collection using the REST API?

3395
T
14 hours ago
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

120
M
1 day ago
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

30
A
1 day ago
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.

60
K
2 days ago
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.

512
D
7 days ago
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!

70
R
7 days ago
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

1362
I
13 days ago
M
Makeswift SupportNew Participant
asked in API & Webhooks
Deleting Archived Contact Doesn't Actually Delete Archived Contact

I have a script, which attempts to create a contact, and if it already exists but is archived, parses the id from the failed message and deletes the contact. Here are the logs from that script: ```Original contact id: 672291a52c6b471a4b20e202--- now let’s call the delete contact endpoint ---Deleted contact response: {"id":"672291a52c6b471a4b20e202","external_id":"<excluded>","type":"contact","deleted":true} -- now let’s attempt to recreate the contact --[16:45:54.629] FATAL (64427): Failed to recreate contact: {"type":"error.list","request_id":"0011vqbd9jo6drvesao0","errors":[{"code":"conflict","message":"An archived contact matching those details already exists with id=672291a52c6b471a4b20e202"}]}``` As you can see, the delete contact endpoint is returning success, but it’s not actually deleting the contact, because my subsequent attempt to recreate the contact fails.

141
Jacques Reynolds
Intercom Team
13 days ago
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": "👷",

272
K
16 days ago
A
Aaron ByromNew Participant
asked in API & Webhooks
Image upload with Rest API

Hey there, I’m finding it difficult to understand the rest API docs around file uploads. I would love to have a user fill out a form, and attach an image, and this would be submitted by the API to create a ticket. I see that the “File” type is supported in the tickets, however I’m finding difficulty in figuring out what Intercom wants as a file.  Is there any more documentation that you could point me towards? Or could you provide a quick example of what an image upload would look like with the API?  Thanks, Aaron. 

7947
O
19 days ago
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.

191
bernice
Intercom Team
21 days ago
Patrick H12
Patrick H12New Participant
asked in API & Webhooks
Any idea why my POST request to add a tag to a conversation via Zapier doesn't work?

I'm pretty new to custom API requests. I want to create a Zapier connection to send a POST request to update a conversation in Intercom to add a tag to a conversation, but I'm having issues. I suspect the issue is with the formatting of the body, but I'm not sure what I'm going wrong. I've successfully performed other GET requests, but I can't get the POST request to work.In the image below you can see I have the following:HTTP Method: POSTURL: https://api.intercom.io/conversations/CONVERSATION_ID/tagsAuthorization: Bearer TOKENAccept: application/jsonBody:{ "id": "12345", "name": "empty-bug-report", "admin_id": "123"}Any ideas where I might be getting this wrong?

423
Patrick H12
30 days ago
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.  

212
Eduardo Soares Azzolin
1 month ago
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? 

913
E
Intercom Team
1 month ago
Andrii Fedyk
Andrii FedykNew Participant
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?

3248
mateusz.leszkiewicz
Intercom Team
1 month ago
A
Ajay ChauhanNew Participant
asked in API & Webhooks
Event propagation delay in intercom workflow trigger audience rule

I have a workflow where in the audience rule I've set custom event which I am firing with condition (event name - count - has any value).But the message prompt doesn't appear at the initial page render. When I refresh the page then I'm able to see the message prompt. I verified that the custom event is firing properly from the network tab. Also the custom event logs in the intercom side is also showing up the correct event at the right time, but not sure why the workflow message prompt is not showing up during the first time. But only visible when we refresh the page. In that case the count also becomes two.Additionally, I have also used alternative audience rule event name - first occured - has any value still it doesn't work properly for the initial first time page loads. Is there a better way to fix/resolve this issue?

233
mateusz.leszkiewicz
Intercom Team
1 month ago
H
hyderNew Participant
asked in API & Webhooks
Possible bug: HTTP 500 when updating an article

We noticed one of our customer help center article was not being updated because of the following response with an HTTP code of 500.{ "type": "error.list", "request_id": "002tv9efacb52hqthea0", "errors": [ { "code": "server_error", "message": "Server Error" } ]} Since the error message doesn't provide specifics, we investigated and found that the issue occurs only when an article contains a callout with more than one paragraph. Here’s the bare minimum how to reproduce the issue: What works: Callout with one paragraph ✅curl --location --request PUT 'https://api.intercom.io/articles/:id' \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer XXX' \--data '{ "body": "<p class=\"no-margin\"></p>\n<div class=\"intercom-interblocks-callout\" style=\"background-color: #feedaf80; border-color:#fbc91633;\">\n<p class=\"no-margin\">Hello Mars</p>\n</div&gt

331
mateusz.leszkiewicz
Intercom Team
1 month ago
R
robin.nguyenNew Participant
asked in API & Webhooks
API Get specific tag of specific conversation

HelloCurrently, I use the Retrieve a Conversation API to get conversation details.https://developers.intercom.com/docs/references/2.7/rest-api/api.intercom.io/conversations/retrieveconversationThis API returns a list of tags associated with the conversation, but it doesn't include information about which specific tag belongs to which conversation part. Could you please advise on how to determine which tag belongs to which conversation part? Thanks. 

241
mateusz.leszkiewicz
Intercom Team
1 month ago
Eduardo Soares Azzolin
Eduardo Soares AzzolinNew Participant
asked in API & Webhooks
Is there a way to filter or sort events in the lisdataevents API?

Hello, everyone!I'm working on building reports in Power BI, and I'm extracting data via the API for that purpose. The data-events API is a bit slow due to the amount of events and it’s making the extraction difficult. Is there any way to filter or sort the events?

201
mateusz.leszkiewicz
Intercom Team
1 month ago
M
MishaActive User
asked in API & Webhooks
Looking for possible values of `` conversation `"part_type" property

Hello, I’ve found this page about possible values of conversation’s “part_type” propertyhttps://developers.intercom.com/docs/references/1.4/rest-api/conversations/conversation-part-model#conversation-part-typesbut it’s missing for current API versions and this list is definitely not complete (e.g. I don’t see there ‘channel_and_reply_time_expectation’ part_type) Is somewhere available a full list of possible `part_type` values ?  I have an integration with Intercom and want to filter out “useless” messages for me when syncing, e.g. messages from operator to the user Thank you in advance.

342
M
1 month ago
K
Kane CochranNew Participant
asked in API & Webhooks
Leveraging the Shopify Order Lookup Feature To Show Custom Attributes

Hey everyone - Excited to get rolling with Intercom. We’ve chosen this platform over others specifically because the API access it offers to allow us to show custom attributes - like Estimated Shipping Date. Gorgias and others can’t do this yet (apparently). The use case is simple. A customer hits the chat and asks “What Is My Estimated Shipping Date”, we respond asking for an Order Number. We use this order number to search the Shopify API, pull back the order details, which includes a custom metafield called estimated_ship_date. We then show that data to the customer.  I’m sure I can do all this with numerous actions. But it seems to me that using the out of the box Order Search as a starting point would be best. I can then access the order.id and do 1 very specific call to pull back metaafields.  My question at this point is … can we use the Order Status feature as a starting point for an automated workflow? If not … does my workflow above make the most sense? Thanks!kane

201
bernice
Intercom Team
1 month ago
J
Júlio CordeiroNew Participant
asked in API & Webhooks
Golang custom event rich link

I am trying to send a rich link in the metadata of a custom event triggered with the intercom-go package. In intercom’s dashboard, it reaches as [Object Object]. Is there any different input format expected for rich links in go, or is it just not supported?  event := intercomlib.Event{ UserID: userId, EventName: eventName, CreatedAt: int64(time.Now().Unix()), Metadata: map[string]any{ some_rich_link: map[string]any{ "url": "https://www.some-custom-url.com", "value": "some-custom-name", }, }, } ic.Events.Save(&event) 

291
Emilygav
Intercom Team
1 month ago
E
Ethan PatrickNew Participant
asked in API & Webhooks
API: Recent Page Views?

Are there any endpoints in the API that would pull the Recent Page Views for a user? 

2035
C
1 month ago
E
Ethan PatrickNew Participant
posted in API & Webhooks
Ability to Trigger Reusable Workflows via REST API?

Having the ability to trigger a reusable workflow via API would be really helpful for making workflow/bot conversations more dynamic. A specific use case I’m working on right now is serving CSAT in conversations where customers interact only with a bot (no team member assigned).  Unresponsive triggers only happen with human to human conversations. If a customer goes unresponsive while talking to the bot, the conversation is considered abandoned, not closed. My thought was to use Zapier to trigger closed conversations and filter by convos NOT assigned to a team member, however I have no way of serving CSAT in that conversation via the API. I played around with starting workflows using this non-documented endpoint:curl --request POST \  --url https://app.intercom.io/ember/inbox/workflows/start \  --header 'Accept: application/json' \  --header 'Authorization: Bearer REDACTED \  --header 'Content-Type: application/json' \  --header 'X-Csrf-Token: REDACTED' \  --cookie _intercom_session=RE

591
mateusz.leszkiewicz
Intercom Team
1 month ago
Ask a question
Terms & ConditionsCookie settings