# Beamer

Beamer is a platform that enables companies to announce news, updates, and features directly within their applications or websites, enhancing user engagement and communication.

- **Category:** notifications
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 12
- **Triggers:** 0
- **Slug:** `BEAMER`
- **Version:** 20260312_00

## Tools

### Count Post Comments

**Slug:** `BEAMER_COUNT_POST_COMMENTS`

Tool to count existing comments on a specific post. Use when you need the total number of comments matching specific filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dateTo` | string | No | Retrieve comments published before this date (ISO-8601 format) |
| `postId` | integer | Yes | ID of the post to count comments for |
| `search` | string | No | Retrieve comments with content that contain this text |
| `dateFrom` | string | No | Retrieve comments published after this date (ISO-8601 format) |
| `language` | string | No | Filter by language using ISO-639 two-letter code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Post Reactions

**Slug:** `BEAMER_COUNT_POST_REACTIONS`

Tool to count existing reactions on a specific post. Use when you need the total number of reactions for a given post.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `postId` | integer | Yes | ID of the post to count reactions for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Posts

**Slug:** `BEAMER_COUNT_POSTS`

Tool to count existing posts. Use when you need the number of posts matching specific filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dateTo` | string | No | Only count posts published before this date (ISO-8601). |
| `filter` | string | No | Count posts with a matching segmentation filter. [Pro plan and up] |
| `userId` | string | No | User ID to use with filterByUserId only. |
| `expired` | boolean | No | Count only expired (true) or non-expired (false) posts. [Starter plan and up] |
| `archived` | boolean | No | Count only archived (true) or non-archived (false) posts. |
| `category` | string | No | Only count posts in this category. |
| `dateFrom` | string | No | Only count posts published after this date (ISO-8601). |
| `language` | string | No | Only count posts with translations in this language (ISO-639 two-letter). [Starter plan and up] |
| `filterUrl` | string | No | Include posts matching this segmentation URL. [Pro plan and up] |
| `published` | boolean | No | Count only published (true) or draft (false) posts. |
| `forceFilter` | string | No | Only count posts that match this segmentation filter. [Pro plan and up] |
| `ignoreFilters` | boolean | No | If true, ignore segmentation filters (requires permission). |
| `filterByUserId` | boolean | No | If true, include single-user posts matching userId. [Scale plan] |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Unread Posts

**Slug:** `BEAMER_COUNT_UNREAD_POSTS`

Tool to count unread posts for a user. Use when you need the number of posts the user would see when opening their Beamer feed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Count unread posts with a matching segmentation filter. |
| `userId` | string | No | ID of the user. |
| `dateFrom` | string | No | Count unread posts published after this date (ISO-8601). |
| `filterUrl` | string | No | Count unread posts with a matching segmentation URL. |
| `userEmail` | string | No | Email of the user. |
| `forceFilter` | string | No | Only count unread posts that match this segmentation filter. |
| `userLastName` | string | No | Last name of the user. |
| `userFirstName` | string | No | First name of the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category

**Slug:** `BEAMER_GET_CATEGORY`

Tool to retrieve metadata for a Beamer category by its ID. Use when you need category information for filtering or grouping posts. Beamer uses a fixed set of categories: new, improvement, fix, comingsoon, announcement, and other.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Unique identifier of the category to retrieve. Valid categories are: 'new', 'improvement', 'fix', 'comingsoon', 'announcement', and 'other'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Feed

**Slug:** `BEAMER_GET_FEED`

Tool to retrieve the URL for your standalone feed. Use after embedding to fetch the feed link for embedding or sharing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `theme` | string | No | Theme class for appearance customization via CSS. Only available on Pro plan and up. |
| `filter` | string | No | Retrieve posts with a matching segmentation filter. Only available on Pro plan and up. |
| `userId` | string | No | ID of the user viewing the feed (for analytics). |
| `language` | string | No | Two-letter ISO-639 code to retrieve feed in a specific language. Only available on Starter plan and up. |
| `userEmail` | string | No | Email of the user viewing the feed (for analytics). |
| `filterByUrl` | boolean | No | Whether to apply URL filtering to the feed. Only available on Pro plan and up. |
| `forceFilter` | string | No | Only retrieve posts matching this segmentation filter. Only available on Pro plan and up. |
| `userLastName` | string | No | Last name of the user viewing the feed (for analytics). |
| `ignoreFilters` | boolean | No | If true, all posts will be retrieved, ignoring segmentation filters. Requires special API-key permission. |
| `userFirstName` | string | No | First name of the user viewing the feed (for analytics). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notification

**Slug:** `BEAMER_GET_NOTIFICATION`

Tool to retrieve details of a specific notification by its unique notification ID. Use after obtaining the notification ID to fetch its full details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notificationId` | integer | Yes | ID of the notification to retrieve (post ID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notifications

**Slug:** `BEAMER_GET_NOTIFICATIONS`

Tool to fetch unread notifications. Use after providing user context to retrieve and mark notifications as read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination of results. |
| `filter` | string | No | Retrieve notifications matching this segmentation filter. (Pro plan+) |
| `userId` | string | No | Analytics: ID of the viewing user (Scale plan+). |
| `category` | string | No | Only notifications in this category. |
| `dateFrom` | string | No | Only notifications published after this ISO-8601 timestamp. |
| `language` | string | No | Two-letter ISO-639 code: only notifications in this language. (Starter plan+) |
| `filterUrl` | string | No | Include notifications matching this segmentation URL. Supports wildcards. (Pro plan+) |
| `saveViews` | boolean | No | Whether to record view counts for the retrieved notifications. |
| `userEmail` | string | No | Analytics: email of the viewing user. |
| `markAsRead` | boolean | No | Mark retrieved notifications as read. (default true) |
| `maxResults` | integer | No | Maximum number of notifications to return (max 10). |
| `forceFilter` | string | No | Only retrieve notifications that match this segmentation filter exactly. (Pro plan+) |
| `userLastName` | string | No | Analytics: last name of the viewing user. |
| `ignoreFilters` | boolean | No | Ignore segmentation filters entirely. Requires special API-key permission. |
| `userFirstName` | string | No | Analytics: first name of the viewing user. |
| `traceableLinks` | boolean | No | Convert links to traceable URLs for click analytics. |
| `ignoreRequestDetails` | boolean | No | Ignore IP/browser/geolocation details when retrieving notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post Comments

**Slug:** `BEAMER_GET_POST_COMMENTS`

Tool to retrieve comments for a specific post. Use after identifying the post ID to list its comments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (>=1) |
| `dateTo` | string | No | Retrieve comments published before this ISO-8601 date |
| `postId` | integer | Yes | ID of the post to retrieve comments from |
| `search` | string | No | Retrieve comments containing this substring in their text |
| `dateFrom` | string | No | Retrieve comments published after this ISO-8601 date |
| `language` | string | No | ISO-639 two-letter code to filter comments by language |
| `maxResults` | integer | No | Maximum number of comments to return (1-10) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post Reactions

**Slug:** `BEAMER_GET_POST_REACTIONS`

Tool to retrieve all reactions associated with a specific post. Use when you need to list reactions and optionally filter by date, reaction type, or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (>=1) |
| `dateTo` | string | No | Only include reactions before this ISO-8601 timestamp |
| `postId` | integer | Yes | ID of the post to retrieve reactions from |
| `dateFrom` | string | No | Only include reactions after this ISO-8601 timestamp |
| `reaction` | string ("positive" | "neutral" | "negative") | No | Filter reactions by type: positive, neutral, or negative |
| `maxResults` | integer | No | Maximum number of reactions to return (1-10) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Posts

**Slug:** `BEAMER_GET_POSTS`

Tool to retrieve a list of posts. Use when you need IDs and titles of posts for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ping API

**Slug:** `BEAMER_PING`

Tool to ping the Beamer API. Use when verifying API key authentication before making further requests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |