Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 527 Topics
  • 1,192 Replies
526 Topics
P
Peter RConnector
asked in API & Webhooks
time_to_admin_reply null

I've noticed quite a few conversations return a null time_to_admin_reply in the conversation.statistics object even though there are agent replies to the conversation in Inbox.  My assumption is that the time_to_admin_reply key would return a duration in seconds of the time from when the conversation was created until the first admin (agent) responded. Is that not the case? If not, why would a conversation with admin replies return a null value?

1090
Eric Fitz
Employee
C
Colin L11Active User
asked in API & Webhooks
Does Conversation Search return Messages?

A couple of months ago we built a workaround to export Messages from Intercom via the unstable Message Export endpoint. In the latest API, does the Search for Conversations return messages? In other words, if I did a search for yesterdays conversations, would it also return one-off / single messages from campaigns or manual messages to Contacts? https://developers.intercom.com/intercom-api-reference/reference#search-for-conversations/p>

170
Eric Fitz
Employee
R
ReedConnector
asked in API & Webhooks
Do contacts I create count as seats in the pricing people reached in the pricing sense?

If I create a bunch of contacts I'm hoping they won't be counted a people reached until they actually use intercom.

910
Eric Fitz
Employee
D
DinosNew Participant
asked in API & Webhooks
Using Zapier to change a lead to a user...

Hey all, I've been evaluating Intercom for what I feel like is a long while...my use case is different than many people here most likely...I don't have an app; just want to use Intercom for marketing & support for my website consulting clients.  The biggest thing I haven't figured out to do yet (without writing code...) is when a new lead signs up for my services (which I'm slowly moving to pre-paid packages that they pay for monthly), I have a Zapier zap that changes their user profile from a lead to a user in Intercom.  Does anyone know if that's possible to do with Zapier? I believe it is from the docs I've read, but any guidance would be awesome :)  Thank you all! DInos

390
D
A
AnoopConnector
asked in API & Webhooks
If we use the API for Data Attribute Model', can we able to fetch the listed attributes from the start of every conversation?

If we use this API https://developers.intercom.com/intercom-api-reference/reference#list-data-attributes can we able to fetch any of the data attributes and pass that attribute value to a variable and then that variable need to be passed on to Watson. If yes could you please provide some guides/steps to achieve this?

400
A
U
User876New Participant
asked in API & Webhooks
How do I get conversations of a contact?

How do I get conversations of a contact? There are methods for getting all conversations and all contacts? Should I loop through all conversations to filter the ones that belong to a given contact?

1900
R
Top Expert ✨
J
James C12New Participant
asked in API & Webhooks
API Reply to the last conversation is failing - user not found

Hi, this is my first post, so go easy :) I'd like to reply to the last conversation using the api. The URL I'm calling is: https://api.intercom.io/conversations/last/reply/p> I'm using this as reference - https://developers.intercom.com/intercom-api-reference/reference#reply-to-a-conversation/p> The message body looks approximately like this: {  "message_type": "comment",  "type": "user",  "user_id": "usersemail@aferry.com",  "body": "Test message"} I've confirmed this user exists but I get this response: {    "type": "error.list",    "request_id": "000sdhmlsb3j8gk6qieg",    "errors": [        {            "code": "not_found",            "message": "User Not Found"        }    ]}Any ideas appreciated. I can't see what could be wrong.

800
J
U
User844New Participant
asked in API & Webhooks
[Bug] Not enough data for Article Inserter webhook event

Hi,Using webhooks to integrate Intercom with some 3rd party software.Subscribed for "conversation.admin.replied" topic. Everything works fine, until the "Article Inserter" is used.When message contains inserted article, the webhook data provided is: 'part_type': 'comment', 'body': '<p>[App: Article Inserter]</p>' So, there is no way to convert such webhook data to message in 3rd party software. We only know that some article was inserted. No url, no ID or title. It will be great if webhook data will contain information about inserted article.Hope it will get fixed someday. P.S. When we use "Insert Article" from Intercom mobile app (without Article Inserter app) - everything works fine, we get the article url in webhook data. But on desktop there is no such button without extra app...

400
Eric Fitz
Employee
V
VidyeshNew Participant
asked in API & Webhooks
1.How Intercom API handle timestamp in search query ? 2.Respnse data in array is not received in correct order for get all contact API despite mentioning order=desc key in qs.

I am also facing weird kind of issue. what happened in my scenario is that is as below (API V is 2.3).As per docs intercom save timestamp data in UTC formatwhen I pass the UTC timestamp to search API sometimes is does not return any result , but at the same time I pass the timestamp of my local region I got requested data . sometimes it happen vise-versain GET All CONTACT API - when requested sometimes data come in ASC order despite mention order=DESC key in query-params I am not sure what is happening at server but I am sure about date is correctly formatted from ISO string to UTC timestamp. Please kindly provide help.

1440
V
A
Ashish ANew Participant
asked in API & Webhooks
Can I use a custom email address when creating a message using the API?

Hi, I am creating a message using the intercom API. I'm able to send the request, but the recipient sees the sender of the email as: firstname.lastname@company.intercom-mail.com My question is that is it possible to configure intercom so that when the recipient sees the email address of the sender, it is the same as the actual email address of the admin? Rather than companyname.intercom-mail.com? The curl request is below: curl --location --request POST 'https://api.intercom.io/messages#39; \--header 'Authorization: {Bearer token}' \--header 'Content-Type: application/json' \--data-raw '{ "message_type": "email", "subject": "Email subject", "body": "The body of the text message goes here.", "template": "plain", "from": { "type": "admin", "id": "{admin_id}" },  "to": { "type&

820
R
Top Expert ✨
R
RajarajanNew Participant
asked in API & Webhooks
Do we have filter support for Count API like we do have for Contacts API(/contacts/search)

Hi, I want to create a dashboard based on different filters from Intercom API. I want to have `session_count` and `signed_up_at` filters in Count API. I tried to figure out from the docs but couldn't find any. Please help on this. Any guidance is welcome

70
R
Top Expert ✨
U
User401New Participant
asked in API & Webhooks
How could I find custom attributes on webhook?

I created a custom attribute on Intercom and I would like to move it to our CRM (Zoho). How would it be visible on webhook?

470
R
Top Expert ✨
U
User517New Participant
asked in API & Webhooks
Can I send an in-app message to a visitor via api?

Is it possible to send a in-app message to a visitor via api? Before they become a lead or a user. Or, is it possible to convert a visitor to a lead or a user via api then send them an in-app message? I'm trying to trigger an in-app message to a visitor after they fill out a form on my website. We are able to retrieve the Visitor ID using the provide JS and it looks something like this: IntercomVisitorId: [0dd41354-f701-4648-94ca-e24df88dadcc] But I don't know how to use this ID to target the visitor with an in-app message. Thanks!

590
U
R
Robert S12New Participant
asked in API & Webhooks
Unable to create note- getting 404 error

Hi, I've mostly managed to navigate the Intercom API without issues. However, I'm struggling to create a note. (I'm using Python, but can replicate the issue with curl.) curl https://api.intercom.io/contacts/5f908d5b37fbb4bceed4c97a/note-X POST -H 'Authorization:Bearer *snip*' -H 'Accept:application/json' -d  { "body": "Shiny", "admin_id": "*snip*"} And I get a 404. Basically, https://api.intercom.io/contacts/lt;intercomid>/note doesn't seem to exist. If I change the URL to https://api.intercom.io/contacts/lt;intercomid>/notes then I get a different error - 400, "Body can't be nil" I am on the latest version (2.3) of the API. Can anyone help please? ThanksRobert

1460
R
R
rajabdeenActive User
asked in API & Webhooks
How to get current workspace name?

we can get workspace_id from request body. where we can get the wokspace name? any API available?

1050
R
T
Tanay SNew Participant
asked in API & Webhooks
I am trying to integrate contcats api in our website.For that we are using the api provided by intercom.But for fetching auth token there is param named "Code" which is missing even we are not able to find it's definition or identity what it is.

Api -https://api.intercom.io/auth/eagle/token Params- {"code":"", "client_id": "d0d273fc-d43c-4c2f-b4c9-1e22e43bcb01","client_secret":(VALUE HIDDEN)}in this api "code" what we need to pass in this param,

190
T
F
Fivetran D11New Participant
asked in API & Webhooks
Intercom API failing when requesting contacts updated between a specified interval

The connector is failing on the following request:'https://api.intercom.io/contacts/5c0549cebebd285b4fa5426f/tags#39; {"type":"error.list","request_id":"001icr5rttiaof24lkkg","errors":[{"code":"not_found","message":"User Not Found"}]}% We make the following API request to get the contacts updated between a specified interval curl -X POST --data '{"query":{"operator":"AND","value":[{"field":"updated_at","operator":">","value":1591488000},{"field":"updated_at","operator":"<","value":1594080000}]},"pagination":{"per_page":150,"starting_after":"WzE1ODUyNDgzOTAwMDAsIjVlNzg4MzdhMGE3MWI4MmRiZTU0MjMzZSIsMTld"}}' -H 'Authorization: Bearer XXXXX' -H 'Accept: application/json' -H 'Intercom-Vers

1470
R
Top Expert ✨
Z
ZevNew Participant
asked in API & Webhooks
Help with Canvas Kit

I'm a newbie, with limited Python knowledge. I built a Canvas Kit, connected to Zapier and SFDC, but not sure how to deploy it live for my team and workspace. Can someone help me? Thanks!

1550
C
M
MishaActive User
asked in API & Webhooks
[Webhooks] User in 'user.tag.created' only have old tags after adding a bunch of new ones

Hello, it's me again with the new question about API and webhooks explicitly. I've noticed strange behavior with 'user.tag.created':When you add only one tag at a time - you get user with this tag in tags field. But when I add a bunch of them user doesn't seem to include new ones in 'tags' field.  Below in my payload you can see that created tag (id: 4783953) is not present in user's tags.I want to know is it expected behavior or no? Thanks in advance Here you can see body of my notification: "body": { "type": "notification_event", "app_id": "ep13p0k7", "data": { "type": "notification_event_data", "item": { "type": "user_tag", "user": { "type": "user", "id": "5f8ffb5d6ed4af944328b4dc", "anonymous": false, "email": "lars@mail.com", "name": "Lars Quincy&q

180
M
L
Lauren D11New Participant
asked in API & Webhooks
How can I get sending stats on outbound messages I've sent through the API?

I was wondering where the best spot would be to find stats on outbound messages sent via API calls. The info I am looking for is just how many messages are sent out this way per month.

910
R
Top Expert ✨
M
MishaActive User
posted in API & Webhooks
forum.intercom.com

Hi, not sure if it's a bug but there are some inconsistencies in webhook notifications. I described some of them here https://forum.intercom.com/s/question/0D52G00004dXbOBSA0/webhooks-user-in-usertagcreated-only-have-old-tags-after-adding-a-bunch-of-new-onesand here https://forum.intercom.com/s/question/0D52G00004dX4uWSAS/different-payloads-for-same-types-from-webhooks-and-rest/p> Currently the biggest concerns for me are: 1) user doesn't have new tags in 'user.tag.created'/'contact.tag.created'; 2) Name is missing in Company in 'company.created' sometimes Thanks in advance 

380
M
V
Vincent GNew Participant
asked in API & Webhooks
Can we able to work/develop/configure the custom bot through API.

When the visitors initiate the chat , We are collecting basic info from users, Our requirement is,When the users filled our form then we just need to send out our meeting link to the users automatically, Is it doable through Custom Bot or API? If yes, Which API will suits for us? Is there any option to share the room link (3rd party Meeting Link) via intercom. We have their 3rd party API With us, Much appreciated if anyone gives solution,

190
R
Top Expert ✨
M
MishaActive User
posted in API & Webhooks
Different payloads for same types from webhooks and REST

For example: Webhook-model has event conversation.user.created which seems to return Conversation type.But if I request the same conversation by id from REST api (i.e. GET /conversations/id) the one from webhook and the one from REST will have different properties . E.g in the webhook's one there is no Source field and not all conversation parts are present. The same goes to contacts If it's intended maybe types from webhook model should be documented separately?

520
M
U
User471New Participant
asked in API & Webhooks
Delete user API from version 1.4 still works?

I have around 6000+ test usres in our account and we are about to go live. I have checked and found out that intercom provides delete user API in version 1.4. I have tried the v1.4 user list API and it is working but when I tried the delete usre API, I believe I got the success response. But when I checked the user list API again, I can still see the user and in intercom interface also I can see the same user. So I am confused now that whether the delete user API actually works or not? Can you please confirm? A quick response will be much appreciated.

210
Eric Fitz
Employee
U
User461New Participant
asked in API & Webhooks
How can I create a Contact with custom attributes? When Iam passing custom attributes , get error response with 500 response code

Api Response  { "type": "error.list", "request_id": "001abpf1ufhhbsgi1ku0", "errors": [   {     "code": "server_error",     "message": "Server Error"   } ]} Value passing  custom_attributes : {"Status": "Active"}

580
L
Employee
Ask a question
Terms & ConditionsCookie settings