Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 527 Topics
  • 1,190 Replies
526 Topics
M
MarkoNew Participant
asked in API & Webhooks
Whats the difference between messages and conversations?

Getting inconsistent responses using the unstable API version for the export endpoints. I also can't seem to parse the gzip response using any python library? What I am aiming towards is retrieving the chats between clients and admins up to 6 years in the past per client for compliance reasons. Is that possible?

7370
M
Employee
Z
ZakActive User
asked in API & Webhooks
Count of Conversations with a tag + Zapier Use

Hi there! I'm a noob when it comes to API stuff, so just still trying to figure it all out.I'm attempting to setup a Zapier hook to pull a total number of conversations with a particular tag on them. Wondering if this is possible? I can see by this https://developers.intercom.com/intercom-api-reference/reference/conversation-counts I'm able to get the total count of conversations, but it doesn't specify if I'm able to also add a filter by tag. For some context that may or not be helpful, for customers that are affected by a bug we'll assign them the relevant bug tag. We can filter by this in reports, but if I can do it as an API call then I can get it into our Notion page which would be super handy. Finally, (and very optionally since it's probably not that related to Intercom lol) any basic advice on how I could implement an API call into Zapier? I tried to set one up and got a bit befuddled when it wanted tokens and auth stuff that I wasn't very famili

330
Z
U
User1344New Participant
asked in API & Webhooks
Is there a way to retrieve only a conversation part from the API without retrieving the full conversation?

I know I can get the entire conversation which contains a list of all the conversation parts but that's overkill for my needs. I have a workflow automation tool that needs to check whether a particular conversation part has already been redacted and would like to get right to that data.

610
M
Employee
M
MarkoNew Participant
asked in API & Webhooks
Can I install more than 1 app on the same workspace? Will this affect the workspace in anyway?

Essentially I have a production workspace and an app linked to it based off the 1.0 API version. I would like to make another app with the latest API version and more permissions and use it to retrieve the data from the same workspace. Will installing this app on the existing workspace break the other app or the workspace itself?

270
E
U
User2226New Participant
asked in API & Webhooks
Passing arbitrary data in conversation custom_attributes doens't work

Hey there, I want to pass arbitrary data as custom_attributes to conversations. The update conversation endpoint succeeds but the data is not returned from the retrieve endpoint. Do you know why? Is this property working and if how? Is arbitrary data even allowed or do I have to define this data upfront?

710
E
X
XIAONew Participant
asked in API & Webhooks
How to send a message through the api to receive a reply from the robot

How to send a message through the api to receive a reply from the robot

220
Daniel M15
Employee
P
Pete HNew Participant
asked in API & Webhooks
Parent_Id not matching article collection/section

I am hitting the articles API and it returns the parent id for each article. Here is the article:https://support.tulip.co/en/articles/2280642-how-to-run-an-app-in-the-tulip-player/p>and its parent is:https://support.tulip.co/en/collections/2983157-introduction-getting-started-with-tulip#general-guides/p>which has an ID of 2983157, but when I call that document from the api I get a parent id of 3463139, which isnt a section or collection in my workspace.  Any idea what could be causing this? Pete

690
E
T
TESTNew Participant
asked in API & Webhooks
Is it possible to increase article statistics and use reactions via API?

Hi, I'm building a custom support page listing articles using API. I saw a report called "Article engagement" with some statistics like "Views", "Conversations" and "Reactions". Is it possible to implement these statistics with API?

150
G
L
Lucas S12New Participant
asked in API & Webhooks
Receiving HTTP error 429 (Too Many Requests) when I'm using /search endpoints, even if I send only 1 request to this endpoint..

Apparently when I do a request for /search endpoints that has many results I receive the HTTP error 429.. e.g:body = { "query": {"field": "updated_at", "operator": ">", "value": 1656362751}, "sort": {"field": "updated_at", "order": "ascending"}, "pagination": {"per_page": 150,}, }   response = request.post(endpoint="https://api.intercom.io/conversations/searchquot;, payload=body)Even if it's only one day of search it leads to that 429 error...

1260
G
R
Rodrigo M12Connector
asked in API & Webhooks
How to connect Intercom to my PowerBI application

Dear friends,  Do you guys know how can I connect my Intercom data into my MS Powerbi? I've searched and it looks like it is possible to get this done using the rest APIs provided by the Intercom but I'm not managing to access them, can someone help me on this?  Kind regards,

10590
B
P
Product T14New Participant
asked in API & Webhooks
Getting: "message": "User Not Found" when trying to merge two contacts that exists in the workspace.

Hello, I am trying to merge contacts leads into users as follow: curl --location --request POST 'https://api.intercom.io/contacts/merge#39; \--header 'Authorization: Bearer toto=' \--header 'Content-Type: application/json' \--header 'Accept: application/json' \--data-raw '{  "from": "623f6320f06ce936269f7bd9",  "to": "6189c5687f416a8308a57a23"}'When I try and query for them individually like this: curl --location --request GET 'https://api.intercom.io/contacts/623f6320f06ce936269f7bd9#39; \--header 'Authorization: Bearer toto=' \--header 'Content-Type: application/json' \--header 'Accept: application/json' The API returns the contact (lead or user) that I want to merge.Also, same result when going through the platform:  https://app.intercom.com/a/apps/glsleifc/users/623f6320f06ce936269f7bd9/all-conversations/p> I get the proper profile with associated conversation. Yet, when I want t

740
P
U
User1303New Participant
asked in API & Webhooks
Will contact.created events ever have `companies` populated?

In my current integration, I made an assumption that if a contact was created and associated to a company that contact's company details would come in on the `contact.created` webhook notification. However, I'm no longer convinced that this is ever the case as I see the creation of a contact and attaching it to a company are always done in 2 separate requests in the UI or via API. Is there ever a case where the `contact.created` notification would contain the contact's company details? I haven't been able to make it work even making the attach to company API request in quick succession after creating a contact.  Are there other webhook notifications we could use to know when the contact becomes attached to a company or any other alternative approaches we could use besides polling the contact for updates?

170
U
E
EmanNew Participant
asked in API & Webhooks
How can I pass user_id with email when sending message ?

can I have an example !

1410
Daniel M15
Employee
V
vidIQNew Participant
asked in API & Webhooks
unidentified user update / add a Tag to unidentified user before open conversation

I use @intercom/intercom-react-native. User is registered with Intercom.registerUnidentifiedUser() and I use Intercom.updateUser({ Tag: 'someTag' })but when I check user in Intercom I see Tag has not been set.

1190
V
U
User1784New Participant
asked in API & Webhooks
The response of admin_initiated_message with create_conversation as true is missing "conversation_id" from response. "https://developers.intercom.com/intercom-api-reference/reference/admin-initiated-conversation".

I'm trying to send a new message using "https://developers.intercom.com/intercom-api-reference/reference/admin-initiated-conversation" api and i'm sending `create_conversation_without_contact_reply` key as true in the payload but the response received doesn't contain any conversation_id in it as described in api_documentation. What i trying to do is to get the conversation_id and then instead of sending a new message every time, Send a message as reply to this conversation.Am i missing something here? Or is there any work around available to handle my scenario?

1000
B
R
Ravi BNew Participant
asked in API & Webhooks
Sending canvas app to conversation through API

Usecase: We have a requirement to create an canvas app and serve it through an API. I could create an app and also serve it through conversation message from Agent view but I am not quite sure how to send it through API. When I intercept intercom UI (Through network monitor) and how it sends app in conversation it does three things Configures the card Initializes the cardSends the card in conversation {"app_id":"----","conversation_id":"15","blocks":[{"type":"messengerCard","canvas":{"id":"-----" Is there any way to do the same thing using API?

630
U
S
SarperNew Participant
asked in API & Webhooks
Create conversation model and create message model have server error

Hi,For create_message and create_conversation have same error. create_message_url = "https://api.intercom.io/messagesquot;create_conversation_url = "https://api.intercom.io/conversationsquot; create_message:{"type":"error.list","request_id":"0000gs3ckh0kbkfn1i4g","errors":[{"code":"server_error","message":"Server Error"}]} create_conversation:{"type":"error.list","request_id":"00b89n0esi3jhj96s2og","errors":[{"code":"server_error","message":"Server Error"}]} Thanks for helping.

420
L
Employee
S
sureshNew Participant
asked in API & Webhooks
Send HTML emails from messages API

Hello, We are using messages API "https://api.intercom.io/messagesquot; to send emails to intercom users from our website.We are trying to send email with HTML but look like API don't support for HTML version. So We have created custom templates into intercom system.  Right now we are looking for to send emails with custom templates, please let us know how we can send emails with template from API. Thanks

5993
A
Employee
O
Ozan UNew Participant
asked in API & Webhooks
Can I update the "title" field of a conversation?

I saw another question here, and the answer was referring to tags, but I would like to update the title field of the conversation via API, the update endpoint doesn't seem to work for that.

780
A
Employee
S
Shashank KNew Participant
asked in API & Webhooks
We are using Intercom's direct integration with whatsapp. Earlier we were using a service called octopod which used to set the phone number and we used that and some intercom apis to add our custom attributes to intercom contacts.

Since we migrated directly to intercom, there is no phone number attribute, there is a Whatsapp Number attribute on the intercom website but when we use the contact or conversation apis, we are unable to get the Whatsapp Number. How can we get the Whatsapp Number using contact ID ?

1040
L
Employee
E
Emily H12New Participant
asked in API & Webhooks
Creating a conversation from a visitor returning an error "Lead Not Found"

Hello!I am trying to create a conversation from a visitor per the doc: https://developers.intercom.com/intercom-api-reference/reference/create-a-conversation I've tried setting `type` to `contact` as indicated. When passing a `user_id` like so: { "from": { "type": "contact", "user_id": "1234567" }, "body": "Hey"} I received the error `Lead Not Found` and the conversation / contact with role lead are not created as expected. How can I create conversations from visitors? Additionally, in an ideal world I would be able to pass a singular user ID (not knowing if this is a visitor or existing Intercom user) and then create a conversation attached to the provided user if they exist, or instead a new user if they did not. Is this at all feasible? Thanks for any help.

1220
L
Employee
A
Anurag MConnector
asked in API & Webhooks
In Conversation model, admin_assignee_id should be of string type.

In the API doc: https://developers.intercom.com/intercom-api-reference/reference/conversation-model/p> admin_assignee_id is mentioned as type string, but on api calling it is coming as integer. 

190
A
R
Raphael (New Participant
asked in API & Webhooks
I am getting a "user not found" reply from the API however the user ID is correct AND existing.

Hi, I am getting a "user not found" reply from the API however the user ID is correct AND existing.I am wondering what could be wrong as I am using the access token that is referenced in our account... any help

1160
A
Employee
A
Anthony S12New Participant
asked in API & Webhooks
When attaching a tag to a conversation, they do not always appear in the conversation view.

When attaching a tag to a conversation, they do not always appear in the conversation view. They do, however, appear against the conversation when retrieved via the API. What can I do to mitigate this and ensure the tag always shows in the conversation? My workflow (simplified), using the node intercom client, is: - await conversation creation- await attachment of one or more tags Intercom client always responds successfully, however, it appears there is some internal intercom mechanism to associate a tag with a conversation part, and that perhaps there is a race condition between the part becoming available and the tag being attached. When I retrieve the conversation from the API, i can see that the tags are attached to the conversation.

550
A
C
Colin L11Active User
asked in API & Webhooks
List of Intercom Token error codes/messages?

Is there a list anywhere of what token errors mean? We're getting this reply for one of our customers:{"type":"error.list","request_id":"002qgl7rvpn5e8fi3vf0","errors":[{"code":"token_suspended","message":"Unauthorized token, suspended application"}]}And we're not sure if 'suspended application' refers to us, or the customer's account.

4450
U
Ask a question
Terms & ConditionsCookie settings