API & Webhooks | Community
Skip to main content

API & Webhooks

Get more out of Intercom using our API and webhooks

  • 560 Topics
  • 1,281 Replies
560 Topics
U
User1928New Participant
asked in API & Webhooks
Is it possible to delay push messages triggered by backend notifications until office hours?

I have set up a push notification triggered by a backend notification, using the Intercom API that we call from an internal service. These calls happen every day around 3am, but we want to restrict sending the push messages during office hours. I tried using the "During office hours" parameter, thinking it was going to delay messages coming outside of that range. But testing it turns out that this instead ignores notifications completely if sent outside of office hours. Is there a way to set this up in a way that handles that delaying of messages automatically, or is that something we need to handle on our end to make sure we only send messages during the time period when we want to deliver them? I've included screenshots of my current setup if that can help: 

1140
U
U
UiPathNew Participant
asked in API & Webhooks
J
Juliana BNew Participant
asked in API & Webhooks
T
TimurConnector
asked in API & Webhooks
How to iterate paginated Contacts search results

RequestPOST https://api.intercom.io/contacts/search Accept:application/json Content-Type: application/json Intercom-Version: 2.4 Authorization: Bearer token   { "query": { "operator": "AND", "value": [ { "field": "email", "operator": "~", "value": "timur+1" } ] } }results in{ "type": "list", "data": [...], "total_count": 78, "pages": { "type": "pages", "next": { "page": 2, "starting_after": "Wy0xLCI1ZjIyYzQzZjkxMjU5NmY1MDNiMjA4ZWUiLDJd" }, "page": 1, "per_page": 50, "total_pages": 2 } }But next requestPOST https://api.intercom.io/contacts/search?starting_after=Wy0xLCI1ZjIyYzQzZjkxMjU5NmY1MDNiMjA4ZWUiLDJd Accept:application/json Content-Type: application/

3170
Racheal
Intercom Team
S
svc-devNew Participant
asked in API & Webhooks
S
ShivprasadNew Participant
asked in API & Webhooks
Hoe can i send html response in conversation reply

Hi,According to https://developers.intercom.com/intercom-api-reference/reference/reply-to-a-conversation it says "Notes accept some HTML formatting." I am using below html as <html> <body> <h4>Share screen recordings</h4><br>            <img src="{video_icon}" alt="no image">            <a href='{record_link}' style="margin-top:30px; text-align:center; display:block;" >Record your screen</a>   </body> </html> However the style part is missing in the output. Can some one guide me what limitation exists on HTML formatting. I wanted to post an app in the reply, but i do not see any rest api where i can embed App in the conversation reply. That's the reson i am posting html form of my app rather than canvas. Kindly let me know if this is possible 

5190
Z
J
Joshua WNew Participant
asked in API & Webhooks
A
AeronNew Participant
asked in API & Webhooks
Is there a way to get only a single field, or a specific list of fields back when querying an object?

 For example, if I want to just get the name of the company, or the date it was created back when I look up the ID? I know that in general I could just ignore the rest, but I'm trying to do this within a Custom Action, and I don't necessarily want to write the whole company object back to the Person I'm looking it up for. For context on why I'm doing this rather than associating that Person directly to the Company, I don't want to pollute my Companies with non-employees of said Company. However, I'd still like to be able to look up what Company they are requesting support for so that we can customize their experience when they are interacting with a bot.

650
Z
U
UnmuktNew Participant
asked in API & Webhooks
H
Hasnain ZNew Participant
asked in API & Webhooks
How to attach contacts to a new company? Unable to do so as the new company isn't accessible.

Created a new company:curl https://api.intercom.io/companies\ -X POST \ -H 'Authorization:Bearer <AuthToken>' \ -H 'Accept: application/json' \ -H 'Content-Type:application/json' -d ' { "name": "Test Company", "company_id": "18ac530", }'It was created successfully. Then used the Intercom generated id for it to attach it to a contact:$ curl https://api.intercom.io/contacts/62fe23da8c9c889b4c86b884/companies\ -X POST \ -H 'Authorization:Bearer <AuthToken>' \ -H 'Accept:application/json' -d '{ "id": <intercom_id for the company> }'Got an error, company not found. The docs say that a company must have at least 1 user to be listed and accessible. But this is a Catch-22 how am I supposed to add users if I am unable to access the company. To confirm, that my initial call to create the company was indeed successful, I ran this:curl \ -s https://api.intercom.io/com

1740
C
U
User1202New Participant
asked in API & Webhooks
Can i create canvas kit apps with google apps script?

hi, i am trying to create an intercom canvas kit, i create a url for initialize and submit flow on google apps script but it don't work well  this is my google apps script code  INITIALIZEfunction doPost(e) { var Json = JSON.parse(e.postData.contents); sendDataSocket(Json)   var CanvasBody = { "canvas": { "content": { "components": [ { "type": "button", "label": "Click ME!!!!", "style": "primary", "id": "url_button", "action": { "type": "submit" } }, ], }, }, };   return ContentService.createTextOutput(JSON.stringify(CanvasBody)).setMimeType(ContentService.MimeType.JSON); }SUBMITfunction doPost(e) { var Json = JSON.parse(e.postData.contents);   var CanvasBody = { "canvas": { "cont

890
U
M
MayankNew Participant
asked in API & Webhooks
A
AhumNew Participant
asked in API & Webhooks
U
User2459New Participant
asked in API & Webhooks
T
TausifNew Participant
asked in API & Webhooks
Dynamic Canvas Kit

Hello There,Consider me new to the intercome and don't have an idea about even the basics of integration. I'm presenting the use case and seeking a solution for it. Once the user opens up the messenger, he will be shown up with a form that is generated through my server (it is not the same every time. It is based on some conditions). The form content is different for different users based on the logic on the server.The user clicks on a button on this form and the response is sent back to the server for some business decisions. So I'm confused with following thingsHow should my server be intimated when the user opens up a messenger (with the user detail)How can I send the UI back in form of JSONHow can I record the response back if a button in that UI is pressed The information available is in bits and pieces and I'm not able to find the end to end example.Looking forward for an end to end example do acheive the use case. Regards,

2650
Daniel M15
Employee
A
AshwinNew Participant
asked in API & Webhooks
A
AgustinNew Participant
asked in API & Webhooks
H
Henrik AActive User
asked in API & Webhooks
U
User2149Active User
asked in API & Webhooks
U
User1387New Participant
asked in API & Webhooks
J
Juan C13New Participant
asked in API & Webhooks
U
User2436New Participant
asked in API & Webhooks
U
User164New Participant
asked in API & Webhooks
U
User2399New Participant
asked in API & Webhooks
T
TimoNew Participant
asked in API & Webhooks
Is there a way to set non-custom attributes of conversations via the API?

We would like to set the "Priority" or "SLA" attributes of conversations in particular. The reason is that we want to externalize the decision making of important vs non important conversations as soon as they come in. In the update conversation API, you can only update custom attributes. Right now we are only interested in Priority and SLA, but in the future we also might want to set tags or other fields. What we already tried: 1.Create an inbox rule that e.g. sets Priority if a custom attribute has a certain value. We set up a webhook to be notified when a new conversation comes in and set that custom attribute on the conversation through the API. Problem with this is that the inbox rule is triggered before we set the custom attribute. We also tried to call the /conversations/{id}/run_assignment_rules API but that only seems to trigger inbox rules which assign conversations. Even if we have an inbox rule that both assigns and sets the priority flag, only the assig

1410
Racheal
Intercom Team
Ask a question
Terms & ConditionsAccessibility statement