Skip to main content
Beamer logo
  • Category: notifications
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: BEAMER
  • Version: 20261101_00

Tools

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

Input Parameters

string
Retrieve comments published before this date (ISO-8601 format)
integer
required
ID of the post to count comments for
Retrieve comments with content that contain this text
string
Retrieve comments published after this date (ISO-8601 format)
string
Filter by language using ISO-639 two-letter code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_COUNT_POST_REACTIONSTool to count existing reactions on a specific post. Use when you need the total number of reactions for a given post.

Input Parameters

integer
required
ID of the post to count reactions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_COUNT_POSTSTool to count existing posts. Use when you need the number of posts matching specific filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_COUNT_UNREAD_POSTSTool 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

string
Count unread posts with a matching segmentation filter.
string
ID of the user.
string
Count unread posts published after this date (ISO-8601).
string
Count unread posts with a matching segmentation URL.
string
Email of the user.
string
Only count unread posts that match this segmentation filter.
string
Last name of the user.
string
First name of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_CATEGORYRetrieve predefined metadata for a category by ID from a local fixed set: new, improvement, fix, comingsoon, announcement, and other.

Input Parameters

string
required
Unique identifier of the category to retrieve. Valid categories are: ‘new’, ‘improvement’, ‘fix’, ‘comingsoon’, ‘announcement’, and ‘other’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_FEEDTool to retrieve the URL for your standalone feed. Use after embedding to fetch the feed link for embedding or sharing.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_NOTIFICATIONTool 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

integer
required
ID of the notification to retrieve (post ID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_NOTIFICATIONSFetch unread notifications for a user, with optional filters and pagination. The request can mark retrieved notifications as read.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_POST_COMMENTSTool to retrieve comments for a specific post. Use after identifying the post ID to list its comments.

Input Parameters

integer
Page number for pagination (>=1)
string
Retrieve comments published before this ISO-8601 date
integer
required
ID of the post to retrieve comments from
string
Retrieve comments containing this substring in their text
string
Retrieve comments published after this ISO-8601 date
string
ISO-639 two-letter code to filter comments by language
integer
Maximum number of comments to return (1-10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_POST_REACTIONSRetrieve reactions for a specific post, optionally filtering by date or reaction type and selecting a page of results.

Input Parameters

integer
Page number for pagination (>=1)
string
Only include reactions before this ISO-8601 timestamp
integer
required
ID of the post to retrieve reactions from
string
Only include reactions after this ISO-8601 timestamp
string ("positive" | "neutral" | "negative")
Filter reactions by type: positive, neutral, or negative
integer
Maximum number of reactions to return (1-10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_GET_POSTSTool to retrieve a list of posts. Use when you need IDs and titles of posts for further operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEAMER_PINGTool to ping the Beamer API. Use when verifying API key authentication before making further requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not