API & Webhooks | Community
Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 549 Topics
  • 1,262 Replies
549 Topics
U
UserOpenDogNew Participant
asked in API & Webhooks
Typescript definition for the webhook payloads

Are there Typescript definitions somewhere of the webhook payloads? Thank you!

1633
Racheal
Intercom Team
B
Bassam TantawiNew Participant
asked in API & Webhooks
Trying to download CSV Failed "The requested resource does not exist; check your path and try again"

I was able to use the NPM “intercom-client” successfully to dataExport a day (as a sample). But I failed to download it.First, I can’t find a way to use the NPM to download the file.Second, trying the job identifier in the documentation and from a normal Axios call throw this error:So in my axios call I added the needed headers as below - I used the dataExport.find to get the download URL:But when the file is downloaded, I get the below: 

1992
B
E
Emily FNew Participant
posted in API & Webhooks
How do we technically implement custom event tracking so that we can track the first time a user does something (i.e. clicks a button) (Cordova)

Hi all - am trying to find documentation for our dev team that give the specific instructions on how to setup custom event tracking so that we pick up the first time someone does something. For instance, sending an email when the customer clicks 'Create Account' which they will only do once. I need to provide the exact steps required from a dev perspective and most of the documentation I've come across is still quite ambiguous. Any insights much appreciated.  Cheers! Emily

960
E
B
Bruno DNew Participant
asked in API & Webhooks
API: export job returns error 500 after a few hours

I'm posting this as a new question, because my previous one is 7 days old and had no reply:This job ID: azzldhejyd7n7mjd When trying to retrieve the data immediately, it works. After some time however (tested 10h30 later), it gave 500 internal server error.I have this with every export: after a larger amount of time, it results in an error 500.According to the documentation, this data should remain available at least 2 days.This is all via the intercom API.Thanks

2720
B
N
NandiniActive User
posted in API & Webhooks
I want to embed the Intercom widget which is within Kissflow's User Interface to our 3rd party community platform.

I want to embed the Intercom widget which is within Kissflow's User Interface to our 3rd party community platform.

170
N
C
Chris K14Connector
asked in API & Webhooks
Unable to search conversations using a custom_attribute.

I verified the attribute exists using the /data_attributes endpoint, but when I send a POST request to /conversations/search, I get: {'type': 'error.list', 'request_id': '001ked9vudjnmtu2fm40', 'errors': [{'code': 'invalid_field', 'message': 'custom_attributes.Details is not a valid search field'}]} I am able to filter on built-in values, like "created_at" etc OK so the code works but the search query using custom_attributes, doesn't.  Anyone else have this same problem?

4030
Daniel M15
Employee
B
Bruno DNew Participant
asked in API & Webhooks
I'm trying to download a report from the API. I retrieve the data after 24 h which gives me a "500 server error", although the documentation says data is available for several days and I don't launch another job in the meantime.

First, I create a job using https://api.intercom.io/export/content/data/p>I receive a job ID.If I retrieve the data as soon as it's available, there's no problem. (retrieving the data is using https://api.intercom.io/download/content/data/my_job_id. However 24h later, the job identifier doesn't work anymore. I get back an internal server error (500). The documentation says data should remain available for download for much longer (several days). Also I didn't launch a different job in the meantime, so I don't understand why the data retrieval is broken.

1090
B
G
Goran KNew Participant
asked in API & Webhooks
Is there an API endpoint that allows the creation of multiple contacts with one call, or does each individual contact creation requires an individual API call?

Is there an API endpoint that allows the creation of multiple contacts with one call, or does each individual contact creation requires an individual API call?

210
Joseph S.
Super User ✨
M
Marc K12New Participant
asked in API & Webhooks
API should return updated data in real-time & simplify updates

The way the Intercom API currently works makes it complicated to reliably create and update contacts. Example 1: Newsletter sign-upList all contacts with that email address.Update existing contact or create new one as needed:If there is a user then update that user.Otherwise if there is a lead then update that lead.Otherwise create a new lead.If an existing contact was updated then also remove an eventual subscription opt-out and "unsubscribe all" flag for that contact. Step 2 can create duplicate leads if, for example:A user was created very recently before the newsletter sign-up (e.g. user created by product sign-up and then they sign up for the newsletter shortly after). Thus the user is not yet returned by the API (delayed) and a new lead created.A lead was created very recently for the newsletter sign-up but the person signs up again shortly after (e.g. because of a network issue). Thus the first lead is not yet returned by the API (delayed) and a new one created.The net

4220
A
B
Brent LNew Participant
asked in API & Webhooks
Custom attribute qualification data fields are no longer being filled by cookies.

We have 3 custom qualification data fields that got created when we first initialized a session using them a long time ago. These field values are being filled in through a cookie.  Yesterday everything seemed to be working okay but now only 1 of the fields (userID) is getting populated with a value but it is not consistent either. Our developer has been unable to determine the cause of the issue between yesterday and today. The only "significant" change was we renewed our contract and we ended up getting rid of the Advanced Workspace Management since we did not use most of the features with that add-on.  How do we get support on this?

360
P
Employee
U
User1631New Participant
asked in API & Webhooks
How can I filter the contacts created after a certain date and, if I have more than one page, scroll through them?

According to the documentation I can only filter and get data from the first page or get all data without filter.But, for example, I made a I posted the request at https://api.intercom.io/contacts/searchand it returned me that I have 8 pages with 50 contacts each, and that they were created with a certain date. But I can only access the data from page 1.So I tried to use the post request to https://api.intercom.io/contacts?per_page=150to be able to reproduce the json that you demonstrate in https://developers.intercom.com/intercom-api-reference/reference/ -cursor paging. But instead of the 8 filtered pages it goes to 62 unfiltered pages.

1150
U
U
User1622New Participant
asked in API & Webhooks
How to migrate API from v.2.10.4 to 4.0.0

Hej, currently we are using the intercom-client v.2.10.4 to create a new contact with the role 'user'.In the version 4.0.0 the API has changed but I cannot create a user with the call 'client.contacts.createUser'.How can I migrate our project so, I can use the latest version of the intercom client?

710
U
M
MorganneNew Participant
asked in API & Webhooks
Is it possible to open the Articles Help Center through the Javascript API? I see there are mobile options (ex: https://developers.intercom.com/installing-intercom/docs/react-native-help-center) but can't find any documentation for a web option.

Is it possible to open the Articles Help Center through the Javascript API? I see there are mobile options (ex: https://developers.intercom.com/installing-intercom/docs/react-native-help-center but can't find any documentation for a web option.

770
A
L
Lisa B13New Participant
asked in API & Webhooks
What is the current API rate limit?

What is the current API rate limit?

17610
L
Employee
L
Lisa B13New Participant
asked in API & Webhooks
Can I use the API to create my own workarounds?

Can I use the API to create my own workarounds?

220
L
Employee
L
Lisa B13New Participant
asked in API & Webhooks
Is it possible to reassign conversations which haven't received a reply after a period of time via the API?

Is it possible to reassign conversations which haven't received a reply after a period of time via the API?

1370
L
Employee
L
Lisa B13New Participant
asked in API & Webhooks
I'm wondering if I can assign a visitor an email address via API?

I'm wondering if I can assign a visitor an email address via API?

830
L
Employee
M
Manish KNew Participant
asked in API & Webhooks
How to export/fetch million of records in bulk using API?

Currently, I am working with a client have million of records(contact, conversation, team, admins etc and they want to export these records to a remote Database where they want to consume the data on their own way. So I am fetching the records using the API and it has a limit of max page size 150. If we want to export around 4.3M records then it will required around 28667 https calls and a huge amount of time. So is there any way to increase the page size or fetch the records in bulk using the API ?

630
Joseph S.
Super User ✨
R
Ron SNew Participant
asked in API & Webhooks
How is pagination supported in conversations/search

There's no mention in the docs how is pagination supported. Trying to add query params per_page and/or page has no effect on the response. I would expect it to affect the page size and the page of results that is returned.Notice that in /conversations, paging works with ?start_after query parameter and this is no in accordance with the API doc.

960
Joseph S.
Super User ✨
S
Sam LNew Participant
asked in API & Webhooks
Is there any way to remove users from companies people list?

Is there any way to remove users/people from companies people list. I know that we can do it manually but there are many companies that we want to edit all at once with an api endpoint like https://api.intercom.io/companies/:id/members/:user_id/p> 

510
Racheal
Intercom Team
K
KirNew Participant
asked in API & Webhooks
It would be nice to be able to create tickets through the api.

It would be nice to be able to create tickets through the api. For example, we need to create a ticket for the sales team in intercom when a user registers in our system. How could this be implemented?

410
Racheal
Intercom Team
Dana
DanaConnector
asked in API & Webhooks
How do I get the author ID for Articles API?

How do I get the specific author ID for Articles API?

1830
Joseph S.
Super User ✨
O
Oskar MNew Participant
asked in API & Webhooks
Is there any plans to release an API to Create / Read / Update / Delete your Macros?

Would be great to develop some apps for this feature 🤙

2390
O
W
WickramarangaNew Participant
asked in API & Webhooks
How do I store a list of items in a custom data attribute?

With the API or from the UI, I can create custom data attributes. These attributes can have one of string, integer, float, boolean, or date values. However, I need to store a list of values in a field.  For example, a user (contact) can be in many teams at once in our system. But with the above model, I can only have one team at a time.  What are the possible ways to implement the above functionality with the API/SDK? Should I use tags, or something else? Thanks in advance.

3080
W
S
SRIHARINew Participant
asked in API & Webhooks
Is it possible to retrieve conversations of a particular company alone ? By providing company ID as a parameter?

I would like to get latest conversation , people name for set of company id's I have offline.Is it possible to do by retriving conversations of a particular company as a first step​. Then retrieve people name from it

370
Oseas
Employee
Ask a question
Terms & Conditions