API & Webhooks | Community
Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 539 Topics
  • 1,226 Replies
538 Topics
F
Fivetran D11New Participant
asked in API & Webhooks
Does the Contact and Company API sends all data which were sent as webhook events (for example user.deleted and company.created events) ?

Hello,We are getting user.deleted and company.creted events which are getting consumed in our application. Can you please confirm that the data within these events if missed out are also coming as part of API response or not? Meaninghttps://api.intercom.io/companies - does it give all the companies ? Meaning even If we miss company.created events, Can we get that data from this API in future?https://api.intercom.io/contacts - Does it gives the users/contacts which are deleted? Meaning If we miss the users.deleted events, can we get this information from this API in future?Let me know If you need any other information.Thanks,Sarwesh  

220
Eric Fitz
Employee
D
Diego RNew Participant
asked in API & Webhooks
How to track emails sent from the API?

Hi,We successfully integrated the messages API to send emails through Intercom from our app. Now I'm wondering if there is any way to track these emails, like you can do on Intercom Web Interface messages:  Thanks in advance.

3060
D
C
Colin L11Active User
asked in API & Webhooks
Intercom PHP SDK is Incredibly Outdated

Hi All, We raised this with the partnership team and on GitHub itself but adding here for visibility. We (and others) pushed an enormous amount of fixes to this library in October last year and it still hasn't been released and as a result, the library doesn't fully support 2.0. https://github.com/intercom/intercom-php/p> Can we get some Intercom resources to finish what needs to be done and get it current again? We'd rather not have to branch it and run our own, only to have to merge back to Intercom if it's subsequently released.

4000
Eric Fitz
Employee
W
Will ONew Participant
asked in API & Webhooks
How to disambiguate canvas webhooks if users reuse one intercom workspace for multiple accounts?

I'm working on an application that integrates with Intercom, and some of my users would like to connect a single Intercom workspace to multiple organizations within my app for organization purposes. This is no problem on my end for the most part, however when it comes to handling webhook responses, it starts to become ambiguous. Previously I was using the `workspace_id` that in on all canvas webhooks, but now I have multiple entities that have that workspace ID, so I can't solely use that. I've considered adding metadata to the contacts themselves, but not all webhooks have a contact associated with them. The last thing I can think of is that they have different OAuth tokens, but webhook responses don't include that so I would have no way of matching it. And as far as I can tell, there's no way I can add some custom metadata to be included in a response per installation of my app. If anyone else has run into this or has any ideas, I'd love to hear!

110
U
U
User2486New Participant
asked in API & Webhooks
Is it only possible to delete a single contact via the API, or can you set up a rule where you specify which customer inquiries you want to delete?

Our issue is that we want to delete all of our customer inquiries +1 year - but doesn't seem possible? We have thousands of customer inquiries that we want to delete in our database, and want to automate this in the feature so that we only save the newest inquiries. https://developers.intercom.com/intercom-api-reference/reference#update-contact Thank you in advance for guidance and help regarding this issue.

200
Eric Fitz
Employee
H
Hugo HNew Participant
posted in API & Webhooks
Can I return Intercom user data to my server using NodeJS?

var Intercom = require('intercom-client'); const client = new Intercom.Client({ token: my_token});client.users.list(function (err, d) { // err is an error response object, or null // d is a successful response object, or null try{ console.log('success') }catch(err){ console.error(err) } }); I need to fetch the users data from intercom to my server. I fellow the instruction https://github.com/intercom/intercom-node.But I don't know if I connect my workspace or not. And the second snap only return d as null.

1000
Eric Fitz
Employee
G
Gustavo BNew Participant
asked in API & Webhooks
Is there a way to use oAuth to retrieve someone else's App Id so that a user can have its Intercom Messenger in our platform?

We are building a platform for companies to train their teams and customers. With our product, clients (companies) can easily build their own academies and invite other users as learners. ​As admins, companies should be able to integrate their Intercom account to our platform, so that their users can contact them through Intercom Messenger. I'm using oAuth for other APIs, but, for this one, I would need their App Id - as far as I know, I cannot get this information through any API. Is that correct? Is there a way to connect their Intercom Account to a Messenger in our platform?​Thanks!

690
U
U
User763New Participant
asked in API & Webhooks
How do I tell the Workspace ID of a new User that installed my app?

Hi,  I have an app that is installed via OAuth for 3rd party users. How do I tell what is their app id?  The rationale is that I'm using webhooks to listen to events for my 3rd party users, which I understand has an app_id within the payload. But I'm unable to map that app_id to which user that particular event is for as there doesn't seem to be anywhere else that provides that information upon OAuth?  Is there an API call that I can make to retrieve the app_id which an Access Token is tied to? Thanks!

2100
Z
P
Peter C11New Participant
asked in API & Webhooks
Can I retrieve tags associated with a company through the API?

I see there is an API for "List Attached Tags" for contacts but not Companies. Is there a way to pull what tags are associated with a company? Or is the returned on "retrieve a company" or "list all companies"?

190
P
R
RubensNew Participant
asked in API & Webhooks
Search for Contacts using the `IN` operator

I'm trying to search my Contacts by their `id` using the `IN` operator that is listed in API v2.3 reference (https://developers.intercom.com/intercom-api-reference/reference#section-accepted-operatorsThis is my current request payload:```json{ "query": { "operator": "OR", "value": [ { "field": "id", "operator": "IN", "value": ["5fec4b003ba34a1198516369","5fec4b003ba34a11ab516481"] } ] }}``` but I get back an invalid response ```json{ "type": "error.list", "request_id": "000bcmd8o18tsjg9qfq0", "errors": [ { "code": "invalid_field", "message": "_id is not a valid search field" } ]}```It looks like that this field can't be used to search with th

3960
D
C
Craig W11New Participant
asked in API & Webhooks
How to use X-Hub-Signature in webhooks?

You mention in the Signed Notifications section in the webhooks docs (https://developers.intercom.com/building-apps/docs/webhook-model#section-signed-notifications that the X-Hub-Signature is a sha1 signature of the payload.body and the client secret. Could you please confirm the order both strings are concatenated (payload.body + client_secret) or (client_secret + payload.body) before you pass through sha1()?  Although I've tried both options I'm yet to get a match, but before I look into the possibility of my payload body causing the issue I'd like to get confirmation on the order the two strings should be concatenated. I'm attempting to pass the concatenated string through a sha1() method to do a string comparison with the header value from the request?  Is the usual method to confirm signature or is there something I've missed?

11400
Eric Fitz
Employee
M
MishaActive User
asked in API & Webhooks
Is it possible to have separate permissions for Access Token and oAuth?

Hola👋  We have intercom integration which is used by our customers and use intercom for ourselves too. Currently we a developing a 'delete account' feature to become GDPR-compliant. So when user in our system requests delete of his theirs data we need to delete it from intercom as well. I assumed that using Access Token for requests gives you all the permissions but seems like I was wrong. When I try to delete a company I get "token_unauthorized". There is a list of permissions in Authentications but AFAIK if I enable delete permissions there they will be requested form our customers who installed our integration too. Is there a way to generate different Permission scopes for API key (internal use) and oAuth (external use)? Thanks in advance for any tips 

1050
Eric Fitz
Employee
D
Diego BNew Participant
asked in API & Webhooks
Can I trigger an email based on an event?

We want to track an event, then based on the event triggers an email Stepsend an event from REST APIAdd a rule on the event in order to trigger an emailcheck if the user has received the mail is that possible setting a rule in Intercom?

6270
Roy
Top Expert ✨
A
Asaf SNew Participant
asked in API & Webhooks
Why am I only getting a single conversation part when calling the API endpoint?

Hey, this is a question about the conversation_part list field, If I recall , I used to be able to receive the entire thread of messages within a conversation but now I only see the a single message in conversation_parts no matter the length of the thread

530
Roy
Top Expert ✨
C
Chris K14Connector
asked in API & Webhooks
In order to connect to the REST API, do we need to sign the query, for example HMAC SHA256?

Even the example from the help guide (yes, I did enter the API token) doesn't work:curl https://api.intercom.io/articles -X GET -H 'Authorization:Bearer <Your access token>' -H 'Accept:application/json' -H 'Content-Type: application/json' Returns the following error:{"type":"error.list","request_id":"001iuuadd47ehouu9ndg","errors":[{"code":"unauthorized","message":"Access Token Invalid"}]}

3850
C
U
User1061Connector
asked in API & Webhooks
Can I open a specific conversation using the Javascript API?

We are handling a review process via Intercom, ie. users request a review, we automatically create a conversation and then all discussions about the review should be done inside this specific conversation. now we want to add a button that opens the conversation but I only see a way to create a new conversion or list all open conversations, but I don't see an API call to open a specific conversation (even when its closed). ie. something like Intercom('showConversation', 123)

2280
Eric Fitz
Employee
U
User977New Participant
asked in API & Webhooks
Syncing custom attributes with Intercom

We are building a platform that helps segment customer feedback. We are wanting to sync the custom attributes from Intercom into our application. We would like to know when custom attributes change on a contact. Is there a webhook for this? or should be periodically poll the API ?

1180
U
J
Jeffrey HConnector
asked in API & Webhooks
Webhook Topic for tag added to company?

Hi, since a few months there's the ability to do more with company tags, so now I'm wondering if a webhook topic for if a tag is added, would be possible to add :)

80
J
A
Anonymous
asked in API & Webhooks
Feedback for Intercom API / Webhooks / SDKs / Canvas Kit / Developer Experience / App Store (question from an Intercom product manager!)

Hey Connectors 👋 I'm the Product Manager of the App Ecosystems team at Intercom and we're currently working on defining our focus areas for the coming year. I'm really eager to hear your feedback to understand what's frustrating? What are you hoping to see? And what's missing from our platform across: Building apps for Intercom (incl. Canvas Kit capabilities)APIs / SDKs / WebhooksDeveloper ExperienceIntercom's App store If you're available for a 30min call next week, it would be great to chat and meet some of you.  You can book a time with me here ➡️ https://calendly.com/rati_intercom/intercom-ae-feedback OR share your feedback by replying to this post. (As a note - I'm definitely including feedback you've already provided here and I'd love to hear more!)

230
T
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.

6700
P
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.

50
Roy
Top Expert ✨
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

450
Roy
Top Expert ✨
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?

1750
D
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?

8950
U
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?

7460
C
Ask a question
Terms & Conditions