Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 496 Topics
  • 1,124 Replies
496 Topics
P
Preston HNew Participant
asked in API & Webhooks
Is there an on ready callback for the Javascript API

Looking to call a function only when the Intercom ( window.Intercom ) object is made available.

6010
P
3 years ago
A
Asaf SNew Participant
asked in API & Webhooks
Are conversation attributes exposed to webhooks?

Is there a way to get the priority field in conversation objects from webhooks? I could not find a topic for it in the list nor do I get the field as a 'by the way' from any of the other webhooks.

30
R
Top Expert ✨
3 years ago
J
Jonny PNew Participant
asked in API & Webhooks
Is there a way to filter retrieved `articles` by searchTerm?

 So far all I can see is `sort & pagination` (search) applies to `contacts` only - but the ability to search articles is what I am looking for - is there a way we can feed in the help centre search results into our apps search results page?  Thank you

420
R
Top Expert ✨
3 years ago
D
Derek PNew Participant
asked in API & Webhooks
What is the difference between users and contacts when using the Stitchdata integration?

When using the Stitchdata integration, what is the difference between the 'Users' and 'Contacts' table? In addition, I'm seeing multiple records created for a single email in the 'Users' and 'Contacts' table. What would cause this to happen? My company is currently using the Stitchdata integration (https://www.stitchdata.com/docs/integrations/saas/intercom) for replicating Intercom data into our warehouse. In the schema, a table titled 'Users' and another titled 'Contacts' exist. What is the difference between these two tables? Also, I see the SAME email being located in both tables. Why is that? Another issue is that, if we are looking at the 'Contacts' table and 'Users' table alone, we see 4-5 records attributed to the same email. Why would this happen?

1560
D
3 years ago
U
User68New Participant
asked in API & Webhooks
Why am I getting a 404 error for this API call?

According to https://developers.intercom.com/building-apps/docs/get-started-developing-on-intercom/u>I have registered in the developer hub.Next I created a developer workspace and created an application. In the application I have ACCESS TOKEN.I am trying to make a simple API request according to https://developers.intercom.com/building-apps/docs/make-an-api-call /u> I send in the console where INTERCOM_ACCESS_TOKEN is Access token on page Authentication in my app in developer-hubI expect to get 200 but get 404. What am I doing wrong?

7200
U
3 years ago
C
CosmoNew Participant
asked in API & Webhooks
Suddenly getting unexpected "409 Conflict" errors today due to multiple identical emails even though we are passing unique "user_id" which normally supersedes email. API v1.0 Intercom bug?

Suddenly getting unexpected "409 Conflict" errors today due to multiple identical emails even though we are passing unique "user_id" which normally supersedes email. API v1.0 Intercom bug?

6080
C
3 years ago
J
Jon-PaulNew Participant
asked in API & Webhooks
Is there a way to get the Intercom user ID from the iOS SDK?

I'm trying to get the user ID in order to make additional API calls, but I can't get it other than by performing an additional API call to look up the user's email address, which seems like a rather roundabout way of doing it?

3310
Eric Fitz
Employee
3 years ago
L
Lucas TNew Participant
asked in API & Webhooks
Is there a webhook for company notes?

I'm looking for a way to trigger a webhook when a note is added to a company. From the documentation this seems like it's not supported, is there a workaround for this?

130
L
Employee
3 years ago
U
User722Connector
asked in API & Webhooks
Hello, are there any ways to rate conversation via API?

Hello, are there any ways to rate conversation via API? I want to send rating for conversation via POST-request and I didn't find any endpoint what can I use for it.

210
U
3 years ago
Z
Zach BNew Participant
asked in API & Webhooks
Looking for reporting help and API transformation

We have begun exporting conversation data from the API to calculate our own metrics, and we're running into issues with calculating the metrics correctly. We need help transforming the data to run some great reporting in Looker.  Our data stack is: Intercom <> Hevo <> Snowflake <> Looker For a few examples, here are some top reports we want to create: Volume by TagsConversation DataChannelAgentTimeTo first admin responseBetween follow up replies  Please reach out if you are a consultant who can help or if you have recommendations on how to find an Intercom Data expert! Thank you!  KEYWORDS: Data, Snowflake, Looker, HELP, Consultant, API, Transformation

550
C
3 years ago
U
User722Connector
asked in API & Webhooks
What exactly is 'conversation_parts'?

I'm trying to set up webhooks (conversation.admin.replied for now) and in the body of webhook i get field `data.item.conversation_parts` and it is a list. I don't why this is a list. Can someone please explain it? What I mean - by every reply I get this webhook and info about this reply is stored in a list, but why? Which cases should I handle where it can be a list with length> 1?

270
R
Top Expert ✨
3 years ago
J
John G12New Participant
asked in API & Webhooks
How often does the Segments COUNT parameter update?

My segments are primarily based on user behavior, like, first seen after z date and "has most recent event in past 7 days"  then I query the segments via the API with the count included, like so:get("/segmentID?include_count=true")  but this gives me a non-real time count. It seems to be the count from the last browser session.  So, when I have a new user, I trigger my api call to grab this data and update my dashboards. but the API returns counts as if that new user has not registered. I have to open a browser window with all the segments to get the counts to update.  Is there a timer on which these counts update, or do I have to open a browser to get them to update, or am I doing something wrong?

260
J
3 years ago
T
TomoyoNew Participant
asked in API & Webhooks
Teams API and adding teammate to Development workspaces

I am using Development workspaces to try out APIs for development of an App.I would like to use Teams API and have some questions related that. 1, Is it possible to add(invite) or delete teammate via API? 2, When I tried to add teammate using Development workspaces, I got the error in the below capture. Is there any limitation to adding teammate in Development workspaces? 

940
R
Top Expert ✨
3 years ago
K
Kevin D14New Participant
asked in API & Webhooks
Can I list company segments through the API?

What's the best way to get a list of company segments from the api? There's only contact segments in the api docs.

120
J
3 years ago
U
User692New Participant
asked in API & Webhooks
As an customer success company we need to have some aggregated information regarding conversations per companies. Does REST API support such things?

From COUNTS documentation: https://developers.intercom.com/intercom-api-reference/reference#conversation-counts/p> But main problem here is that this information is not grouped by companies. Is there way to do some aggregation or grouping by company for conversation statistics?

30
U
3 years ago
U
User722Connector
posted in API & Webhooks
Hi, i can't send reply to conversation via API, but can do it via intercom website. Please, can you see request with this id 003abpt6qlp4obiq78ig and help me?

Hi, i can't send reply to conversation via API, but can do it via intercom website. Please, can you see request with this id 003abpt6qlp4obiq78ig and help me?

1960
U
3 years ago
R
Rodrigo M12Connector
asked in API & Webhooks
Sending a message to company users using webhook

Dear community, hope you all are doing great! I'm looking for the following solution: I'm setting up a workflow in my CRM app that must connect to my Intercom workspace and send a message to the users of a specific company. I'm trying to do this via webhook. The problem is that I have no idea of how can I make this automation. It's been a few weeks that started to work with multi-plataforms connections and I did not learned how to achive a few things yet.  I'll attach the webhook setup screen from my CRM, this may help us to solve the requirement. Thanks a lot for your help, Kind regards,Rodrigo.

330
R
3 years ago
J
Jack C12New Participant
asked in API & Webhooks
Can I get custom user attributes via API?

In https://www.intercom.com/help/en/articles/179-send-custom-user-attributes-to-intercom,I createdwindow.intercomSettings = { app_id: APP_ID, "book": "ABC" }; How to get the key value pair book & ABC via API?

1890
R
Top Expert ✨
3 years ago
M
MishaActive User
asked in API & Webhooks
Have anyone experienced fails with webhooks verification?

I have some troubles with webhooks. For unknown reasons Webhook's verification fail for one particular customer. But not for all the time. Sometimes it succeeds (I'd say it fails 1 out of 10 ).Do you have any tips on how to debug this issue? I logged the payload and it doesn't look suspicious. Just a regular user.tag.created event. Here is how I verify webhook```const verifySignature = ({payload, secret, signature}) => { const stringified = JSON.stringify(payload); const calculatedSignature = `sha1=${crypto .createHmac('sha1', secret) .update(stringified) .digest('hex')}`; if (calculatedSignature !== signature) { throw badRequest(`Invalid signature provided`); }};export const verifyWebhook = ({clientSecret}) => async ({params, payload}) => { verifySignature({ payload, //req.body parsed by koa-body secret: clientSecret, signature: params['x-hub-signature'], }); return {id: payload.app_id};};```Thanks in advance for

1100
M
3 years ago
Y
YuriyaNew Participant
asked in API & Webhooks
Is it possible to pull Intercom data (users & companies) through API to fulfil Zendesk ticket fields?

We already have Intercom integrated into Zendesk and it works well. However, we want to achieve another level and automate ticket fields fulfilment.

480
R
Top Expert ✨
3 years ago
U
User957New Participant
asked in API & Webhooks
Will upgrading the app API version on Intercom developer hub affect the intercom app?

I would like to use from REST API features such as queries for searching conversations however our API version is 1.0 and so we'd need to upgrade it.  I am wondering whether changing the API version will cause any breaking changes in the intercom app.  FYR this is what I'm talking about: https://developers.intercom.com/intercom-api-reference/v1.0/reference#get-a-single-conversation & https://developers.intercom.com/intercom-api-reference/reference#search-for-conversations As you can see, V2.3 allows queries in searching for conversation where we'll search by the user id  

160
U
3 years ago
M
Mario UNew Participant
asked in API & Webhooks
Is it possible to reply to a conversation without triggering an email notification?

Is there a way to reply to a conversation via API without notifying the associated user/contact (e.g. sending e-mails)? It looks like Intercom has some logic as replying via API sometimes does and sometimes does not trigger an email.

1310
S
3 years ago
K
Kamil CNew Participant
asked in API & Webhooks
How can i create a custom attribute on a contact?

I am using the Ruby API and the following code gets an error:" (Custom attribute 'kamil_attribute_console' does not exist)" user_id = 1 intercom_query = intercom.contacts.search('query': {'field': 'external_id', 'operator': '=', 'value': "#{user_id}"}) contact = intercom_query.first contact.custom_attributes = {"kamil_attribute" => "here-iam-update-me"} intercom.contacts.save(contact)  

9860
R
Top Expert ✨
3 years ago
J
Jean-BaptisteNew Participant
asked in API & Webhooks
How can I post a message as Operator

I made an app that post messages into conversations using the Intercom API, and I want those messages to come from a bot/operator, not from the contact nor the admin. Here is a screenshot of an app that posted such a message, but I cannot find how to achieve this in the API docs… Thanks for your help! 

2320
R
Top Expert ✨
3 years ago
U
User1140Active User
asked in API & Webhooks
Initiate Outbound chat from within a webpage, with passed parameters.

We have mentors who go over our clients (students) homework. I want them to be able to initiate chats with a student if they have a note about a specific homework task hey submitted. (i.e. "your answer to question 13 is incomplete"). Mentors have users in our Intercom (they are team members), but I want the mentors to be able to launch the chat from the UI they use to check students homework rather than go into intercom look up the user and initiate a chat.  So I want them to be able to click a button next to a task they are checking, which will pop up either the messenger or any other way to send a message, where the user is already set (based on the email of the student I will pass to Intercom) and the task name/number included in the default text. Is there a way to achieve this natively, via an integration or via API?  

220
U
3 years ago
Ask a question
Terms & ConditionsCookie settings