API & Webhooks | Community
Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 545 Topics
  • 1,247 Replies
545 Topics
Z
zapierdeveloperNew Participant
asked in API & Webhooks
D
doudNew Participant
asked in API & Webhooks
How to Display a List of Options in a Custom Data Connector?

Hello, I’d like to create a custom data connector. In my business, we sell coding programs with different session dates, and I want users to be able to check upcoming sessions from our database. To retrieve the relevant sessions, I need to collect a few details from the user:- Program of interest- Format- Campus (we have up to 25 campuses) For the campus selection, I don’t want users to type manually — I’d like to display a list of available campuses they can simply click on. Is this possible with a data connector? I see that Fin supports data inputs like text, number, decimal, and boolean — but is there a way to present a list of options (e.g. dropdown or buttons) for users to choose from? Thanks in advance!

212
conor
Innovator ✨
M
Mike WestNew Participant
asked in API & Webhooks
S
SproutSocialNew Participant
asked in API & Webhooks
Intercom.initialize Causing ANR's 15.1.4

Hi, we’re running into an issue with ANRs on our application stemming from the initialize call on the Intercom SDK. We are currently using 15.1.4 of the Android SDK with the following code used for initialization: Intercom.initialize(this, INTERCOM_API_KEY, INTERCOM_APP_ID); I have updated the SDK to 15.5.1 but we haven’t had time to collect data, I am wondering if this will suffice, I didn’t see anything the latest or previous release notes that would indicate so. Below is the exception from firebase : main (runnable):tid=1 systid=3084 at io.intercom.android.sdk.errorreporting.ExceptionParser.<clinit>(ExceptionParser.java:11) at io.intercom.android.sdk.errorreporting.ErrorReporter.create(ErrorReporter.java:18) at io.intercom.android.sdk.Injector.getErrorReporter(Injector.java:319) at io.intercom.android.sdk.Injector.getLifecycleTracker(Injector.java:310) at io.intercom.android.sdk.Injector.initWithAppCredentials(Injector.java:135) at io.intercom.android.sdk.Intercom$Companion.create(I

1942
T
M
MindyNew Participant
asked in API & Webhooks
C
cooldevNew Participant
asked in API & Webhooks
Getting 404, 502 and 504 error from API at the first time then success after retry

My context:API version: 2.12API call: search and update contact 404 Curl request at 2025-03-31 09:50:33 { "headers": { "content-length": "74", "user-agent": "GuzzleHttp/7", "host": "api.intercom.io", "authorization": "********", "accept": "application/json", "content-type": "application/json" }, "body": "{\"query\":{\"field\":\"external_id\",\"operator\":\"=\",\"value\":\"vegastars_78859\"}}", "url": "https://api.intercom.io/contacts/search", "method": "POST"} Here is the response at 2025-03-31 09:50:33: I have double-checked that the value exists in Intercom. However, the weird thing is that when my server calls the API, it returns an error response. Then, when the request is retried by the queue, it succeeds.I want to make sure that are these response such as 404 and 502, 504 coming from your side ? { "body": "<html><head><title>404 Not Found</title></head><body><center><h1>404 Not Found</h1></center><hr><center>nginx</center></body></html>", "method": 404}

622
mateusz.leszkiewicz
Intercom Team
P
Paula ShulerNew Participant
asked in API & Webhooks
L
Laura AllahverdiNew Participant
asked in API & Webhooks
S
SmockNew Participant
asked in API & Webhooks
A
Alex D.New Participant
asked in API & Webhooks
Exporting articles - how do you actually export them using the API?

Hi I know that I need to use the API to export articles, and I’ve looked at a couple of existing questions around this. The answer seems to be, you need to use the API and to look at the article Formatting and exporting your articles with the API for answers. That article doesn’t have any information about exporting articles using the API. It has one line of text right at the bottom, pointing you to the developer docs, but not guidelines as to how to start. I looked at the data export section of the developer docs and gave that a try, and first of all found out that it will only pull data from a 90 day period, so pretty useless if you want to export docs that have been created over time. I tried the Export API endpoint with a shorter time period and still had issues. For anyone else trying, you first have to Create a Data export, the response from that request will give you a job number. You then need to download the data export, using the job number. I tried this in the Intercom test

1432
TBelevska
H
HugoNew Participant
asked in API & Webhooks
Using Intercom's API to calculate common conversation metrics

I have been using the Intercom API to try to recreate the regular metrics in Metabase. I have tried using this resource but haven’t found it to be particularly helpful. For example, if I try this query, the response maps to the New Conversations Metric in the Intercom dashboard instead of the Assigned Conversations metric which is my intention. SELECT "Inbox Details - Team Assignee"."inbox_name" AS "Inbox Details - Team Assignee__inbox_name", COUNT(*) AS "count"FROM "public"."conversations_data" LEFT JOIN "public"."inbox_details" AS "Inbox Details - Team Assignee" ON "public"."conversations_data"."team_assignee_id" = "Inbox Details - Team Assignee"."inbox_id"WHERE ( ( "Inbox Details - Team Assignee"."inbox_name" = 'VIP Support Inbox' ) OR ( "Inbox Details - Team Assignee"."inbox_name" = 'Support' ) OR ( "Inbox Details - Team Assignee"."inbox_name" = 'VIP Escalation Inbox' ) OR ( "Inbox Details - Team Assignee"."inbox_name" = 'Escalation Inbox' ) ) AND ( "public"."conversations_data"."c

471
A
P
paulmwatsonNew Participant
asked in API & Webhooks
API Returns Cannot submit an array as a custom attribute value

Hello, We created a custom attribute with the list type called `Channel Networks`. When we try to update it via the API we get back the following error: ``` { type: 'error.list', request_id: 'REDACTED', errors: [ { code: 'nested_custom_attributes', message: 'Cannot submit an array as a custom attribute value' } ]} ``` Other custom attributes work fine, just list/array type ones fail. ``` const respIntercom = await fetch( `https://api.intercom.io/contacts/${contact_id}`, { method: 'PUT', headers: { 'Content-Type': 'application/json', 'Intercom-Version': '2.12', Authorization: `Bearer ${process.env.INTERCOM_ACCESS_TOKEN}` }, body: JSON.stringify({ "name": userData.user.name + " TEST", "phone": userData.user.phone, "last_seen_at": userData.user.last_online, "signed_up_at": userData.user.created_at, "custom_attributes": { "ACME": userData.user.acme, "Channel Networks": ["Channel 1", "Channel 2"], } }) } ); ```

361
Jacques Reynolds
Intercom Team
J
Jay GNew Participant
asked in API & Webhooks
Is there any way to create a callback request through the API?

Hi, I wanted to know if there is any possible way to trigger a callback request through setting a conversation attribute ‘last_inbound_call_estate’ to ‘Awaiting callback’. As all I can seem to find is that this data attribute is only accessible through the phone workflow and can only be added and modify by Fin though the workflow. It would be nice if there was an option to set the ‘last_inbound_call_estate’ to ‘Awaiting callback’ for any conversation so the active team members would automatically get the call in their inbox, just like when they request a callback through the phone workflow, but without them having to actively call… Wether it is though API or through a messenger workflow it would be nice to integrate.

381
Jacques Reynolds
Intercom Team
V
Victor AndréeNew Participant
asked in API & Webhooks
Update custom object references through REST API v2.13

The v2.13 REST API introduces support for creating, updating, and reading custom object instances. But, the documentation does not say anything about updating references – either on those instances themselves, or references to custom objects as custom attributes on people. Without the ability to associate custom objects with contacts or conversations, the API doesn’t seem very useful. I’ve tried to pass contact IDs and external IDs, and objects with an “id” key with no success, both as arrays and as simple attributes. Based on how the contacts/{id}/companies endpoint works, I’d probably expect the following to work: POST /custom_object_instancesContent-Type: application/json {"external_id": "123", "custom_attributes": {"Owner":{"id":"6602eae0ca854b5e2a01f503"}} And if the attribute support multiple people, it should support an array. Supporting objects, instead of just the ID, would allow you to support identifying references with both Intercom’s ID and external ID, so that’d be nice.

713
V
B
Bounce EngineeringNew Participant
asked in API & Webhooks
A
Aaron ByromNew Participant
asked in API & Webhooks
E
Eduardo LNew Participant
asked in API & Webhooks
L
lifanActive User
asked in API & Webhooks
P
PodporaNew Participant
asked in API & Webhooks
Discrepancy in Pagination Format for /companies/list Endpoint

Hi, I am currently using the OpenAPI specification provided in your YAML file to generate an API client for the /companies/list endpoint. According to the YAML, pagination is implemented via a "pages" object, which includes a "next" property defined as a starting_after_paging object. This object is expected to contain properties like per_page and starting_after. However, the actual API response returns the "next" property as a plain URL string, for example: "pages": { "type": "pages", "next": "https://api.intercom.io/companies/list?page=2&per_page=1&order=desc", "page": 1, "per_page": 1, "total_pages": 223},"total_count": 223 I have verified that this behavior is consistent even when using the API testing tool provided at https://developers.intercom.com/docs/references/rest-api/api.intercom.io/companies/listallcompanies Could you please clarify whether this is a known issue or an intentional change in the API implementation that has not yet been reflected in the YAML documentation? Any

611
Paul Byrne
Intercom Team
R
Rasmus Wedel-Heinen AndersenNew Participant
asked in API & Webhooks
M
Mitch EvansNew Participant
asked in API & Webhooks
Optional/nullable params in Custom Action

Hello, I have a custom action that is supposed to send a request to my server along with multiple url params attached. The problem is however, not ALL of the params are sent for every request. Yet, since they are declared in the Request section of Custom Actions the call fails presumably because not every param has a value. The questions are, 1.) are we able to set these params to be “optional” and I’m just missing the option? 2.) Why can’t Intercom just recognize that this param is empty, and input a null, or avoid the param all together and leave validation up to the server receiving side? AKA, my server. I just feel like this product is feature limited to the point its useless, at least for my use case. And yes, I have tried for hours to Google, watch Youtube videos, browse articles (even found this one), reach out to support (no response), and just plain ol’ trying things on my own before coming here. So don’t give me the ol’ “Search Google” non-sense. PRODUCTIVE AND SUPPORTIVE ANS

3909
E
N
nikospNew Participant
asked in API & Webhooks
D
DriboNew Participant
asked in API & Webhooks
[Feature Request] Send whatsapp templates via REST API

Hi guys, As far as I know, currently there is no option for sending Whatsapp templates via REST API (correct me if I’m wrong). Whatsapp don’t allow sending messages via their API directly if the number is already connected to your system. That leave us without options in order to have only 1 single point of contact number for receiving user’s questions and being able to automate templates for our users. Other competitors (like Messagebird) already allow to send whatsapp templates via their API. So the question is, is there any plan to allow this in your API? Is there any ETA? This feature is quite important and if there is no plan to implement it would make customers contemplate switching providers. Thanks in advance.

782
D
M
Matheus SimonaciNew Participant
asked in API & Webhooks
Issue with searching tickets containing spaces in Intercom API

I'm experiencing an issue when using the Intercom API to search for tickets. When I try to search for a title that contains spaces, the API does not return the expected results. For example: The query below returns the ticket correctly: { "query": { "field": "title", "operator": "~", "value": "Atraso" } } However, when I add a space after "Atraso", no results are returned: { "query": { "field": "title", "operator": "~", "value": "Atraso " } } I have already tried the following approaches without success: Using regular expressions with \b Encoding the space as %20 Using the exact match operator "=" Expected result : [ { "type": "ticket.list", "pages": { "type": "pages", "page": 1, "per_page": 20, "total_pages": 1 }, "total_count": 1, "tickets": [ { "type": "ticket", "id": "9", "ticket_id": "3", "ticket_attributes": { "_default_title_": "Atraso na criação de atividades no Pipedrive", "_default_description_": "Solicitação de análise urgente de atraso na criação de atividades no Pipedrive,

221
Jacques Reynolds
Intercom Team
N
Nawfal MellahNew Participant
asked in API & Webhooks
401 error "token_not_found" but the access token is provided

Hello, I am using Intercom API in a GCP cloud run to do several things, especially updating a user. Sometimes it works, but sometimes I get an 401 error: “token_not_found”, and I checked multiple times with logs: I am always sending the access token and it’s the right one. “intercom_user_id” is also the right one. I also checked multiple times my server and logic, and there’s no error. Here are some request ids where this error happened: 0003sad4ua316ingi1l0, 000an1qat9nc63bsg160, 0021017ivsn8tt93ipd0. Here is the call in python: url = f"https://api.intercom.io/contacts/{intercom_user_id}"headers = { "Authorization": f"Bearer {settings.INTERCOM_ACCESS_TOKEN}", "Intercom-Version": "2.12", "Content-Type": "application/json",} update_dict = intercom_profile.model_dump() try: response = await httpx_client.put(url=url, headers=headers, json=update_dict) if response.status_code != 200: log.info(response.json()) log.info(f"INTERCOM_ACCESS_TOKEN: {settings.INTERCOM_ACCESS_TOKEN}") return False

451
mateusz.leszkiewicz
Intercom Team
Ask a question

Most helpful members this week

Terms & ConditionsAccessibility statementYour Privacy Choices