Beamer

Beamer integration (Communication, Productivity). Imported from open-connector.

API key4 toolshttps://api.getbeamer.com/v0

GET

beamer_get_feed_url

Retrieve the standalone Beamer feed URL with optional language and segmentation filters.

/url

3 parameters

Param	Type	Required	Description
language	string	optional	A two-letter ISO-639 language code used by Beamer for feed localization.
filterByUrl	boolean	optional	Whether URL segmentation should be applied to the feed URL.
filter	string	optional	An optional segmentation filter string to apply.

GET

beamer_count_unread_posts

Count unread Beamer posts for one end-user context.

/unread/count

2 parameters

Param	Type	Required	Description
userId	string	optional	The end-user identifier used together with filterByUserId.
filterByUserId	boolean	optional	Whether to include single-user posts that match the provided userId.

GET

beamer_list_posts

List existing Beamer posts with optional changelog, audience, and analytics filters.

/posts

21 parameters

Param	Type	Required	Description
filter	string	optional	Retrieve posts with a matching segmentation filter.
forceFilter	string	optional	Only retrieve posts that match this segmentation filter.
filterUrl	string	optional	Retrieve posts with a matching segmentation URL.
dateFrom	string	optional	An ISO-8601 date-time string accepted by the Beamer API.
dateTo	string	optional	An ISO-8601 date-time string accepted by the Beamer API.
language	string	optional	A two-letter ISO-639 language code used by Beamer for localized content.
category	string	optional	Retrieve posts for a specific category.
published	boolean	optional	Whether to retrieve only published or only draft posts.
archived	boolean	optional	Whether to retrieve only archived or only non-archived posts.
expired	boolean	optional	Whether to retrieve only expired or only non-expired posts.
filterByUserId	boolean	optional	Whether to include single-user posts that match the provided userId.
userFirstName	string	optional	The end user's first name used for analytics attribution.
userLastName	string	optional	The end user's last name used for analytics attribution.
userEmail	string	optional	The end user's email used for analytics attribution.
userId	string	optional	The end-user identifier used for analytics attribution.
traceableLinks	boolean	optional	Whether Beamer should rewrite links into tracked URLs.
ignoreRequestDetails	boolean	optional	Whether backend request IP, browser, OS, and geolocation details should be igno…
saveViews	boolean	optional	Whether fetching these posts should save views in Beamer analytics.
maxResults	integer	optional	The maximum number of posts to return.
page	integer	optional	The results page to retrieve.
ignoreFilters	boolean	optional	Whether Beamer should ignore segmentation filters when returning posts.

POST

beamer_create_post

Create a new Beamer changelog post with one or more translations.

/posts

25 parameters

Param	Type	Required	Description
title	array	required	The translated post titles in Beamer order.
content	array	required	The translated post content values in the same order as the titles.
category	string	optional	The category to assign to the new post.
publish	boolean	optional	Whether to publish the post immediately.
archive	boolean	optional	Whether the post should start archived.
pinned	boolean	optional	Whether the post should be pinned to the top of the feed.
showInWidget	boolean	optional	Whether the post should appear in the embedded widget.
showInStandalone	boolean	optional	Whether the post should appear in the standalone feed.
boostedAnnouncement	string	optional	The boosted announcement treatment to apply to the post.
linkUrl	array	optional	The translated CTA URLs in Beamer order.
linkText	array	optional	The translated CTA labels in Beamer order.
linksInNewWindow	boolean	optional	Whether links should open in a new tab or window.
date	string	optional	An ISO-8601 date-time string accepted by the Beamer API.
dueDate	string	optional	An ISO-8601 date-time string accepted by the Beamer API.
language	array	optional	The translated language codes in Beamer order.
filter	string	optional	The segmentation filter string for this post.
filterUserId	string	optional	The single-user filter identifier or semicolon-separated identifiers for this p…
filterUrl	string	optional	The URL targeting filter string for this post.
enableFeedback	boolean	optional	Whether feedback should be enabled for the post.
enableReactions	boolean	optional	Whether reactions should be enabled for the post.
enableSocialShare	boolean	optional	Whether social sharing should be enabled for the post.
autoOpen	boolean	optional	Whether the Beamer sidebar should auto-open for recipients.
sendPushNotification	boolean	optional	Whether a web push notification should be sent for the post.
userEmail	string	optional	The email of the Beamer account user creating this post.
fixedBoostedAnnouncement	boolean	optional	Whether a boosted top-bar announcement should stay fixed on screen.