NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Beamer connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 Beamer actions, such as "Get Category", "Get Feed" and "Get Notification". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Beamer, with input parameters and output schema.
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
Retrieve comments published before this date (ISO-8601 format)
ID of the post to count comments for
Retrieve comments with content that contain this text
Retrieve comments published after this date (ISO-8601 format)
Filter by language using ISO-639 two-letter code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ID of the post to count reactions for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_COUNT_POSTSTool to count existing posts. Use when you need the number of posts matching specific filters.
Input parameters
Only count posts published before this date (ISO-8601).
Count posts with a matching segmentation filter. \[Pro plan and up\]
User ID to use with filterByUserId only.
Count only expired (true) or non-expired (false) posts. \[Starter plan and up\]
Count only archived (true) or non-archived (false) posts.
Only count posts in this category.
Only count posts published after this date (ISO-8601).
Only count posts with translations in this language (ISO-639 two-letter). \[Starter plan and up\]
Include posts matching this segmentation URL. \[Pro plan and up\]
Count only published (true) or draft (false) posts.
Only count posts that match this segmentation filter. \[Pro plan and up\]
If true, ignore segmentation filters (requires permission).
If true, include single-user posts matching userId. \[Scale plan\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Count unread posts with a matching segmentation filter.
ID of the user.
Count unread posts published after this date (ISO-8601).
Count unread posts with a matching segmentation URL.
Email of the user.
Only count unread posts that match this segmentation filter.
Last name of the user.
First name of the user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_GET_CATEGORYTool 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
Unique identifier of the category to retrieve. Valid categories are: 'new', 'improvement', 'fix', 'comingsoon', 'announcement', and 'other'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Theme class for appearance customization via CSS. Only available on Pro plan and up.
Retrieve posts with a matching segmentation filter. Only available on Pro plan and up.
ID of the user viewing the feed (for analytics).
Two-letter ISO-639 code to retrieve feed in a specific language. Only available on Starter plan and up.
Email of the user viewing the feed (for analytics).
Whether to apply URL filtering to the feed. Only available on Pro plan and up.
Only retrieve posts matching this segmentation filter. Only available on Pro plan and up.
Last name of the user viewing the feed (for analytics).
If true, all posts will be retrieved, ignoring segmentation filters. Requires special API-key permission.
First name of the user viewing the feed (for analytics).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
ID of the notification to retrieve (post ID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_GET_NOTIFICATIONSTool to fetch unread notifications. Use after providing user context to retrieve and mark notifications as read.
Input parameters
Page number for pagination of results.
Retrieve notifications matching this segmentation filter. (Pro plan+)
Analytics: ID of the viewing user (Scale plan+).
Only notifications in this category.
Only notifications published after this ISO-8601 timestamp.
Two-letter ISO-639 code: only notifications in this language. (Starter plan+)
Include notifications matching this segmentation URL. Supports wildcards. (Pro plan+)
Whether to record view counts for the retrieved notifications.
Analytics: email of the viewing user.
Mark retrieved notifications as read. (default true)
Maximum number of notifications to return (max 10).
Only retrieve notifications that match this segmentation filter exactly. (Pro plan+)
Analytics: last name of the viewing user.
Ignore segmentation filters entirely. Requires special API-key permission.
Analytics: first name of the viewing user.
Convert links to traceable URLs for click analytics.
Ignore IP/browser/geolocation details when retrieving notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_GET_POST_COMMENTSTool to retrieve comments for a specific post. Use after identifying the post ID to list its comments.
Input parameters
Page number for pagination (>=1)
Retrieve comments published before this ISO-8601 date
ID of the post to retrieve comments from
Retrieve comments containing this substring in their text
Retrieve comments published after this ISO-8601 date
ISO-639 two-letter code to filter comments by language
Maximum number of comments to return (1-10)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_GET_POST_REACTIONSTool 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
Page number for pagination (>=1)
Only include reactions before this ISO-8601 timestamp
ID of the post to retrieve reactions from
Only include reactions after this ISO-8601 timestamp
Filter reactions by type: positive, neutral, or negative
Maximum number of reactions to return (1-10)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_GET_POSTSTool to retrieve a list of posts. Use when you need IDs and titles of posts for further operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BEAMER_PINGTool to ping the Beamer API. Use when verifying API key authentication before making further requests.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Beamer actions on Nagent, including "Get Category", "Get Feed" and "Get Notification". Get Category: Retrieve metadata for a Beamer category by its ID. Each action is listed on this page with its input parameters and its output.
Beamer connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Category takes 1 required input: category_id. It returns data, error and successful.