> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: List Live Newsfeed Items

> List the news items live on an Intercom newsfeed. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the news items live on an Intercom newsfeed.

> [!NOTE]
>
> Tool ID: `intercom_list_live_newsfeed_items`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_live_newsfeed_items',
  {
    "newsfeed_id": "newsfeed_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_live_newsfeed_items --input '{
  "newsfeed_id": "newsfeed_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "list",
    "pages": {
      "type": "pages",
      "page": 123,
      "next": {
        "per_page": 123,
        "starting_after": "cursor_123"
      }
    },
    "total_count": 123
  }
}
```

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

## Input reference

You can fetch a list of all news items that are live on a given newsfeed

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.newsfeed_id` | `string` | Yes | — | The unique identifier for the news feed item which is given by Intercom. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch a list of all news items that are live on a given newsfeed",
    "properties": {
      "newsfeed_id": {
        "type": "string",
        "description": "The unique identifier for the news feed item which is given by Intercom."
      }
    },
    "required": [
      "newsfeed_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Paginated Response |
| `result.data.type` | `"list" \| "conversation.list"` | No | — | The type of object Allowed: `list`, `conversation.list`. |
| `result.data.pages` | `object \| null` | No | — | Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. |
| `result.data.pages.type` | `"pages"` | No | — | the type of object `pages`. Allowed: `pages`. |
| `result.data.pages.page` | `integer` | No | — | The current page |
| `result.data.pages.next` | `object \| null` | No | — | — |
| `result.data.pages.next.per_page` | `integer` | No | — | The number of results to fetch per page. |
| `result.data.pages.next.starting_after` | `string \| null` | No | — | The cursor to use in the next request to get the next page of results. |
| `result.data.pages.per_page` | `integer` | No | — | Number of results per page |
| `result.data.pages.total_pages` | `integer` | No | — | Total number of pages |
| `result.data.total_count` | `integer` | No | — | A count of the total number of objects. |
| `result.data.data` | `array` | No | — | An array of Objects |
| `result.data.data[].type` | `"news-item"` | No | — | The type of object. |
| `result.data.data[].id` | `string` | No | — | The unique identifier for the news item which is given by Intercom. |
| `result.data.data[].workspace_id` | `string` | No | — | The id of the workspace which the news item belongs to. |
| `result.data.data[].title` | `string` | No | — | The title of the news item. |
| `result.data.data[].body` | `string` | No | — | The news item body, which may contain HTML. |
| `result.data.data[].sender_id` | `integer` | No | — | The id of the sender of the news item. Must be a teammate on the workspace. |
| `result.data.data[].state` | `"draft" \| "live"` | No | — | News items will not be visible to your users in the assigned newsfeeds until they are set live. |
| `result.data.data[].newsfeed_assignments` | `array` | No | — | A list of newsfeed\_assignments to assign to the specified newsfeed. |
| `result.data.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.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". |
| `result.data.data[].labels` | `array` | No | — | Label names displayed to users to categorize the news item. |
| `result.data.data[].cover_image_url` | `string \| null` | No | — | URL of the image used as cover. Must have .jpg or .png extension. |
| `result.data.data[].reactions` | `array` | No | — | Ordered list of emoji reactions to the news item. When empty, reactions are disabled. |
| `result.data.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.data[].created_at` | `integer` | No | — | Timestamp for when the news item was created. |
| `result.data.data[].updated_at` | `integer` | No | — | Timestamp for when the news item was last updated. |
| `result.data.data[].name` | `string` | No | — | The name of the newsfeed. This name will never be visible to your users. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Paginated Response",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of object",
            "enum": [
              "list",
              "conversation.list"
            ]
          },
          "pages": {
            "type": [
              "object",
              "null"
            ],
            "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.",
            "properties": {
              "type": {
                "type": "string",
                "description": "the type of object `pages`.",
                "enum": [
                  "pages"
                ]
              },
              "page": {
                "type": "integer",
                "description": "The current page"
              },
              "next": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "per_page": {
                    "type": "integer",
                    "description": "The number of results to fetch per page."
                  },
                  "starting_after": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "The cursor to use in the next request to get the next page of results."
                  }
                },
                "additionalProperties": false
              },
              "per_page": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "total_pages": {
                "type": "integer",
                "description": "Total number of pages"
              }
            },
            "additionalProperties": false
          },
          "total_count": {
            "type": "integer",
            "description": "A count of the total number of objects."
          },
          "data": {
            "type": "array",
            "description": "An array of Objects",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "The type of object.",
                      "enum": [
                        "news-item"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "description": "The unique identifier for the news item which is given by Intercom."
                    },
                    "workspace_id": {
                      "type": "string",
                      "description": "The id of the workspace which the news item belongs to."
                    },
                    "title": {
                      "type": "string",
                      "description": "The title of the news item."
                    },
                    "body": {
                      "type": "string",
                      "description": "The news item body, which may contain HTML."
                    },
                    "sender_id": {
                      "type": "integer",
                      "description": "The id of the sender of the news item. Must be a teammate on the workspace."
                    },
                    "state": {
                      "type": "string",
                      "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live.",
                      "enum": [
                        "draft",
                        "live"
                      ]
                    },
                    "newsfeed_assignments": {
                      "type": "array",
                      "description": "A list of newsfeed_assignments to assign to the specified newsfeed.",
                      "items": {
                        "type": "object",
                        "description": "Assigns a news item to a newsfeed.",
                        "properties": {
                          "newsfeed_id": {
                            "type": "integer",
                            "description": "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)."
                          },
                          "published_at": {
                            "type": "integer",
                            "description": "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"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "labels": {
                      "type": "array",
                      "description": "Label names displayed to users to categorize the news item.",
                      "items": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The label name."
                      }
                    },
                    "cover_image_url": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "URL of the image used as cover. Must have .jpg or .png extension.",
                      "format": "uri"
                    },
                    "reactions": {
                      "type": "array",
                      "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.",
                      "items": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The emoji reaction to the news item."
                      }
                    },
                    "deliver_silently": {
                      "type": "boolean",
                      "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Timestamp for when the news item was created.",
                      "format": "timestamp"
                    },
                    "updated_at": {
                      "type": "integer",
                      "description": "Timestamp for when the news item was last updated.",
                      "format": "timestamp"
                    }
                  },
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "description": "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](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier for the newsfeed which is given by Intercom."
                    },
                    "type": {
                      "type": "string",
                      "description": "The type of object.",
                      "enum": [
                        "newsfeed"
                      ]
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the newsfeed. This name will never be visible to your users."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Timestamp for when the newsfeed was created.",
                      "format": "timestamp"
                    },
                    "updated_at": {
                      "type": "integer",
                      "description": "Timestamp for when the newsfeed was last updated.",
                      "format": "timestamp"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.