The News API allows you to easily manage news items and newsfeeds.
News are shared through news items which can be assigned to multiple newsfeeds.
A newsfeed is a collection of news items, targeted to a specific audience. Newsfeeds currently cannot be edited through the API, please refer to this article to set up your newsfeeds in Intercom.
Object Models
News Item
| Field | Type | Description |
|---|---|---|
| type | string | The type of object. |
| id | string | The unique identifier for the news item which is given by Intercom. |
| workspace_id | string | The id of the workspace which the news item belongs to. |
| title | string | The title of the news item. |
| body | string | The news item body, which may contain HTML. |
| sender_id | integer | The id of the sender of the news item. Must be a teammate on the workspace. |
| state | string | News items will not be visible to your users in the assigned newsfeeds until they are set live. |
| newsfeed_assignments | array | A list of newsfeed_assignments to assign to the specified newsfeed. |
| labels | array | Label names displayed to users to categorize the news item. |
| cover_image_url | string | URL of the image used as cover. Must have .jpg or .png extension. |
| reactions | array | Ordered list of emoji reactions to the news item. When empty, reactions are disabled. |
| deliver_silently | boolean | When set to true, the news item will appear in the messenger newsfeed without showing a notification badge. |
| created_at | integer | Timestamp for when the news item was created. |
| updated_at | integer | Timestamp for when the news item was last updated. |
The table below defines the subset of HTML accepted when creating or updating a news item. Over time we may add support for new HTML elements and attributes, since this will not constitute a breaking change, we advise any client code to support the full HTML specification when reading news item content.
Supported HTML
| Tag | What does it do? | Additional Details |
|---|---|---|
<p> | Paragraph | All text must be placed within paragraph tags. |
<br> | Line break | Supported in-line. |
<hr> | Horizontal rule | NA |
<h1> <h2> | Heading | Only these two header tags are supported. All others will be replaced with <h2>. |
<a> | Link | An image can be placed in-between the link tags. |
<img> | Image | Images will be uploaded to Intercom and we'll use an Intercom link to display these. If these fail to upload then we'll hard fail and return 400 Bad Request. |
<ul> <ol> <li> | List | Lists must contain at least one non-empty <li> element.<li> elements can contain plain text, or any other supported HTML tags, except <table>.If these criteria aren't met, then the news item will hard fail and return 400 Bad request. |
<table> | Table | Needs to have at least one row and one cell. Can contain any other supported HTML tags, except another <table> within.If these criteria aren't met then it will hard fail and return 400 Bad request. |
<iframe> | Video | src must be for a supported video embed link.Only works for Youtube, Wistia, Vimeo, Loom, Vidyard or StreamIO. |
<pre> <code> | Pre-formatted code | |
<b> <strong> | Bold | |
<i> <em> | Italic |
Supported CSS
| Class | What does it do? | Where does it work? |
|---|---|---|
| intercom-align-center | Center Alignment | On tag level: Headers, Paragraphs. On wrapping div: Images, Buttons. |
| intercom-h2b-button | Button | On tag level: Links |
Unsupported HTML
| Tag | What does it do? | What do we do? |
|---|---|---|
<dl> | Definition List | Hard fail - 400 Bad Request |
<ul> or <ol> | Nested lists | Hard fail - 400 Bad Request |
<iframe> | iFrame Unsupported video | Hard fail - 400 Bad Request |
<div> <span> | Content division | Replace with <p> |
<h3> to <h6> | Heading | Replace with <h2> |
<form> | Form | Remove from content |
<input> <textarea> | Input | Remove from content |
<script> | Javascript Script | Remove from content |
<head> <html> <footer> etc. | All other tags | Remove from content Internals replaced with <p> |