API & Webhooks

Get more out of Intercom using our API and webhooks

  • 435 Topics
  • 1,002 Replies

435 Topics

J
Johan ONew Participant
asked in API & Webhooks

How do I trigger events on company level

Hi, I'm a little new to intercom but would like to work wtih it in a very technical automated way. We would like to be able to insert events that happen on the company level, and then trigger some emails / notifications to specific types of users (eg has ADMIN label) based on that event happening.  So for example:  Company onboards in our own system with a number of usersWe create the company entity in intercomWe create the user entities in intercom and associate them with the companyWe throw an event to intercom that the company "has_been_onboarded"Intercom rules pick up the event and send emails only to ADMIN users that welcomes them to our service So here the event is on the company level, but it should trigger an email to specific types of users within the company. Is this possible? A few quick tips & pointers would be really appreciated! /Johan

4
U
1 day ago
F
Fabian DittrichNew Participant
asked in API & Webhooks

https://api.intercom.io/companies/list not working

Hi,  Using the “/companies” with scroll parameters works without problems. Somehow though I need a way to read companies starting with the most recently added, and it seems “companies/list” is the only way to do that.  No matter how I query “companies/list”, no matter what parameters I set for page, per_page and  order I always get this same error:{"type"=>"error.list", "request_id"=>"003kmpu8u10s0f0dgeb0", "errors"=>[{"code"=>"company_not_found", "message"=>"Company Not Found"}]} Can you advise?

1
mateusz.leszkiewicz
2 days ago
T
thisisntjonNew Participant
asked in API & Webhooks

Help Setting Up SMS Alerts for VIP Calls Using Intercom

Hello,I’m trying to set up an SMS alert system in Intercom for when a VIP customer calls in. The plan is to use the phone workflow to trigger an API call, which then triggers an event. This event should prompt an SMS to be sent to a specific segment of our team.I've been attempting to use "Last contacted" for the created_at field and "Contact ID" for user_id in my API setup, but I keep encountering JSON format errors. If anyone has experience with setting up similar workflows or can offer insights into what might be going wrong, I'd greatly appreciate your help. Also, if there's a different approach that could achieve the same outcome, I’m open to suggestions!Thanks in advance for your assistance!

1
mateusz.leszkiewicz
2 days ago
K
kmchucNew Participant
asked in API & Webhooks

Unable to POST Contact using email

I’m currently trying to POST a Contact with just an email, and am currently being met with a 400 error:Request body:{"name": "Kim Chuc", "email": "email@gmail.com"}Response body:{ "type": "error.list", "request_id": "0004n8c4t4e6a3olv82g", "errors": [ { "code": "invalid_document", "message": "either_email_or_user_id_present validation failed" } ]} Based on the docs, email is the only required field to POST a Contact and I’ve double checked to make sure the email doesn’t already exist: Has anyone ever come across this issue before? 

1
Jacob Cox
3 days ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

How to get id of lead merged to user

The REST API has a method for merging contacts from lead to user. It works pretty simple:```curl -i -X POST https://api.intercom.io/contacts/merge \  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \  -H 'Content-Type: application/json' \  -H 'Intercom-Version: 2.10' \  -d '{ "from": "LEAD_ID", "into": "USED_ID" }'```Also, lead can be merged to user in the Intercom app. When lead is merged, our integration listen for webhook with topic `contact.merged`. This webhook has an information to what contact the lead was merged, but has a missing part from what lead: ```{ "type": "notification_event", "app_id": "abcdee", "data": { "type": "notification_event_data", "item": { "type": "contact", "id": "USER_ID", "workspace_id": "abcdee", "...": "..." } }, "links": {}, "topic": "contact.merged", "delivery_status": "pending", "delivery_attempts": 1, "delivered_at": 0, "first_sent_at": 1713533523, "created_at": 1713533523, "self": null}``` May you add lea

1
E
8 days ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

How to get information about Article in message?

When admin replies with an article, webhook does not contain details about it. May we have a link to article in webhooks? 

2
E
8 days ago
E
ElonMusk228New Participant
asked in API & Webhooks

Getting 403 error from specific IP

Hi! When I use a specific IP address, all my POST requests to the api (https://api-iam.intercom.io/messenger/web/ping) return a 403 error. However, this does not apply to other ip addresses. Is it possible that my ip address is blocked?

3
Jacob Cox
11 days ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

Does access token obtained with OAuth has expiration date?

Our application uses OAuth to get user’s access token. We noticed that after a while tokes are revoked and API calls fails with unauthorized errors. An example:```json{  "type": "error.list",  "request_id": "0003hg8qe7evlq01dqcg",  "errors": [{ "code": "unauthorized", "message": "Access Token Invalid" }]}```May I ask if access tokens obtained through OAuth have expiration date? If there a way to debug why token is invalid now?

1
Andrii Fedyk
13 days ago
D
Doug WehmeierNew Participant
asked in API & Webhooks

Impossible to update archived contacts?

I’m running into a problem when attempting to sync contacts from our platform.  Currently I’m doing the following:Call the contacts/search endpoint, searching by email address If Contact is found, update it If Contact is not found, attempt to create itI’m occasionally getting the following error on step #3:An archived contact matching those details already exists with id=123456 I cannot search for Contact 123456 in the UI.  If I attempt to GET the Contact through the API, I get an error “User Not Found”.I cannot blindly update the Contact because I don’t know their Intercom ID, and that’s the only way to call an update that I can find.So how do I locate and update these archived records?

1
aykut.aydin
14 days ago
E
Eduardo G11New Participant
asked in API & Webhooks

Is there a way to bulk create/update users via API?

I have an application with a few thousand users that I would like to create/update in intercom and synchronise at least weekly with attributes that are calculated by my backend and that are required for contextual engagement. The Contacts API does not support bulk updates and has two major constraints for large volume: i) it requires your app to understand whether a contact has already been created before calling with POST or PUT (the javascript SDK does not suffer from this); ii) the API rate limits are ridiculously small for any medium-sized user base (166 requests per 10s window, what???), which are even smaller if you need to check if a user exists before issuing either a POST or PUT. Furthermore, the Contacts API requires you to save the intercom id for a user for any updates, which is not user-friendly at all. The javascript SDK operates from the external_id provided (controlled by my app), while the REST API does not understand it at all and requires you to either call a GET or

7
Jacob Cox
17 days ago
C
Colin L11Active User
asked in API & Webhooks

Intercom Webhook IPs

Two questions on the Intercom webhooks (https://developers.intercom.com/building-apps/docs/webhooks - Are they all located the USA? - Are canvas kit webhooks from the same IPs? 

2
A
20 days ago
E
Ethan PatrickNew Participant
asked in API & Webhooks

API: Recent Page Views?

Are there any endpoints in the API that would pull the Recent Page Views for a user? 

2
B
21 days ago
R
Raphael BochnerNew Participant
asked in API & Webhooks

"dev_method" from Intercom we ran into an error: The app returned "404".

HelloWe are running into this error since this morning on the conversations end pointhttps://api.intercom.io/conversationsThis was working fine before for months and we didn’t change anything on our end. We are running 1000’s of api calls a day so the errors are running in the high thousands since this morning.  Anyone noticed anything ?  

2
R
23 days ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

How to show sending message error?

Hello, I’m working on a new channel for Intercom. The service receive and forward messages between Intercom and 3th party chat app. When agent reply to chat, we receive related webhook and forward it to external app. There are cases, when we can’t forward the message (e.g. external service is down, or respond an error for particular user). Is there a way to notify agent about problem with sending particular message?

2
Larissa Alberti
29 days ago
J
James BowmanNew Participant
asked in API & Webhooks

How to create news items via API or RSS

Hi I am trying to connect my Canny Changelog with intercom News. Ideally when a new changelog is created it would post on intercom news as well

3
K
1 month ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

Small issue with Create conversation endpoint

When call API to create a conversation with empty `body` and one file attached, the API response with an error, but on https://app.intercom.com/a/inbox/ the chat appear.Here an example of CURL:```bashcurl --location 'https://api.intercom.io/conversations' \--header 'Authorization: Bearer <admin_token>' \--header 'Content-Type: application/json' \--header 'Intercom-Version: 2.10' \--data '{    "from": {        "type": "user",        "id": "<contact_id>"    },    "subject": "Test Subject",    "attachment_urls": [        "https://picsum.photos/seed/picsum/512/512"    ]}'```The example of response:```JSON{    "type": "error.list",    "request_id": "0035jabkv5b82qmiu3cg",    "errors": [        {            "code": "server_error",            "message": "Server Error"        }    ]}``` 

1
Jacob Cox
1 month ago
H
habraham_martellotech.comNew Participant
asked in API & Webhooks

What is the expected format to pass request body while calling https://api.intercom.io/contacts

I am trying to fetch 150  contacts per page while calling  https://api.intercom.io/contacts.but on trying to do so , i am getting the following error {"type":"error.list","request_id":"0069rm2ubh0lgdfr7kg0","errors":[{"code":"invalid_document","message":"either_email_or_user_id_present validation failed"}]} attaching the REST API INTEGRTION code below: ( implemented using Salesforce Apex) String endpoint=’ https://api.intercom.io/contacts’HttpRequest request = new HttpRequest(); request.setEndpoint(endpoint); request.setMethod('GET'); request.setHeader('Authorization', 'Bearer ' + INTERCOM_API_TOKEN); request.setHeader('Accept', 'application/json'); request.setHeader('Content-Type','application/Json');       Integer perPage = 150;  String json= '{'+                        ' "per_page":'+perPage +   '}';   system.debug(json); request.setBody(json); Could you kindly share your thoughts on how to handle this error . Any input is highly appreciated . Thank you 

2
H
1 month ago
P
PraveenNew Participant
asked in API & Webhooks

Delete Contact API not working

i am trying to delete contact with API and it keeps giving me error "errors":[{"code":"not_found","message":"User Not Found"}] , i double checked about the id i am passing and it is correct. i also check for this error code but didn't find anything in the documentation

4
Jacob Cox
1 month ago
M
Michael MollathNew Participant
asked in API & Webhooks

Intercom('showArticle', articleId) is not working for mew

The JS API call is not working for me → Intercom('showArticle', articleId) I am using some othe JSAPI calls on the same page which are wirking.Are there any known issues?  

6
R
1 month ago
U
User1636New Participant
asked in API & Webhooks

Is there a bug in your message API?

Hi there,I am trying to leverage the messages endpoint (https://api.intercom.io/messages and send an email using Intercom, with the template 'plain'. However, it seems like the 'message_type' body parameter is not working, since I send it and it generates an in-app message instead of an email. Here is the body of my request:{ "message_type": "email", "subject": "Hey", "body": "test", "template": "plain", "from": { "type": "user", "id": "63db09ccde07bab99d849eb0" }, "to": { "type": "user", "id": "630e7f6692c1ab99a7ef98af" } }And here is the response I am getting:{ "type": "user_message", "id": "1585218670", "created_at": 1675374629, "subject": "Hey", "body": "test"

5
mateusz.leszkiewicz
1 month ago
Andrii Fedyk
Andrii FedykNew Participant
asked in API & Webhooks

How to receive webhooks with FIN replies

Hello, I have an integration which listen for admin’s reply to the conversations. When admin sent reply the service receive conversation.admin.assigned webhook. When I assign chat to Fin, I see on app.intercom.com that Fin sent a message to the chat, but I don’t see a related webhooks in the logs.Is there dedicated topic for Fin replies?

6
V
1 month ago
B
Benjamin FontanNew Participant
asked in API & Webhooks

conversation.admin.assigned webhook is not triggered when assignment is done through inbox rules

I set up a webhook when a conversation is assigned to an admin (conversation.admin.assigned). It works fine and is triggered correctly when the assignment is done manually, but it is not triggered at all when it is done through inbox rules. Is this expected?

1
W
1 month ago
O
OllieDolanNew Participant
asked in API & Webhooks

Best way to collect Customer Satisfaction?

Hi, Im currently collecting customer satisfaction by querying all the individual conversations and making the calculation myself. It would be nice if there was direct access to pull the customer satisfaction report, but besides that the issue with pulling individual conversations is that if a users account is deleted their conversation is too, preventing me from getting perfectly accurate results. The question is, whats the best way for me to pull customer satisfaction then if i cant rely on pulling individual conversations? 

3
Jacob Cox
1 month ago
V
Venkat NarasimhanNew Participant
asked in API & Webhooks

Search ticket by title (Multiple words)

As an example, I want to search for all tickets which have the text “high priority” in the title (The words must appear together in the title)I am unable to figure out how to do this.

1
mateusz.leszkiewicz
2 months ago
K
KirillNew Participant
asked in API & Webhooks

API -> Untag multiple contacts

Hello,I’ve been successfully using the Intercom API to tag multiple contacts at once using the /tags endpoint. However, I’m now facing a challenge: I need to remove tags from multiple contacts, but I can’t find a straightforward solution in the documentation.Here’s the snippet I’ve been using to tag contacts:const resp = await fetch( `https://api.intercom.io/tags`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Intercom-Version': '2.10', Authorization: 'Bearer <YOUR_TOKEN_HERE>' }, body: JSON.stringify({name: 'test', users: [{ id: 'userId1' }, { id: 'userId2' }] }) } );https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Tags/createTag/  Now, I’d like to perform the reverse operation: remove tags from multiple contacts. Is there an equivalent endpoint for this task? I’ve checked the documentation, but it seems that the /contacts/{contact_id}/tags endpoint is not suitable for bulk removal due

1
bernice
2 months ago
Ask a question
Terms & ConditionsCookie settings