Intercom: Create News Item

Publish an Intercom news item announcing product updates, news or events to customers.

Tool ID: intercom_create_news_item

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_create_news_item',
  {
    "title": "VP of Engineering",
    "sender_id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_create_news_item --input '{
  "title": "VP of Engineering",
  "sender_id": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "news-item",
    "id": "id_123",
    "workspace_id": "workspace_123"
  }
}

Use deepline describe intercom_create_news_item --json for the latest machine-readable contract.

Input reference

A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.

Name	Type	Required	Default	Details
`payload.title`	`string`	Yes	—	The title of the news item.
`payload.body`	`string`	No	—	The news item body, which may contain HTML.
`payload.sender_id`	`integer`	Yes	—	The id of the sender of the news item. Must be a teammate on the workspace.
`payload.state`	`"draft" \| "live"`	No	—	News items will not be visible to your users in the assigned newsfeeds until they are set live. Allowed: `draft`, `live`.
`payload.deliver_silently`	`boolean`	No	—	When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.
`payload.labels`	`array`	No	—	Label names displayed to users to categorize the news item.
`payload.reactions`	`array`	No	—	Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
`payload.newsfeed_assignments`	`array`	No	—	A list of newsfeed_assignments to assign to the specified newsfeed.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.
`result.data.type`	`"news-item"`	No	—	The type of object. Allowed: `news-item`.
`result.data.id`	`string`	No	—	The unique identifier for the news item which is given by Intercom.
`result.data.workspace_id`	`string`	No	—	The id of the workspace which the news item belongs to.
`result.data.title`	`string`	No	—	The title of the news item.
`result.data.body`	`string`	No	—	The news item body, which may contain HTML.
`result.data.sender_id`	`integer`	No	—	The id of the sender of the news item. Must be a teammate on the workspace.
`result.data.state`	`"draft" \| "live"`	No	—	News items will not be visible to your users in the assigned newsfeeds until they are set live. Allowed: `draft`, `live`.
`result.data.newsfeed_assignments`	`array`	No	—	A list of newsfeed_assignments to assign to the specified newsfeed.
`result.data.newsfeed_assignments[].newsfeed_id`	`integer`	No	—	The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).
`result.data.newsfeed_assignments[].published_at`	`integer`	No	—	Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is “draft”. Format: `timestamp`.
`result.data.labels`	`array`	No	—	Label names displayed to users to categorize the news item.
`result.data.cover_image_url`	`string \| null`	No	—	URL of the image used as cover. Must have .jpg or .png extension. Format: `uri`.
`result.data.reactions`	`array`	No	—	Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
`result.data.deliver_silently`	`boolean`	No	—	When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
`result.data.created_at`	`integer`	No	—	Timestamp for when the news item was created. Format: `timestamp`.
`result.data.updated_at`	`integer`	No	—	Timestamp for when the news item was last updated. Format: `timestamp`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation