Beamer

Learn how to use Beamer with Composio

Overview

SLUG

BEAMER

Description

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

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: BEAMER_COUNT_POSTS

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

Action Parameters

archived
boolean
category
string
dateFrom
string
dateTo
string
expired
boolean
filter
string
filterByUserId
boolean
filterUrl
string
forceFilter
string
ignoreFilters
boolean
language
string
published
boolean
userId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_CATEGORY

Tool to retrieve a specific category by its id. use when you need to load metadata for a category before filtering or grouping posts by that category.

Action Parameters

category_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

filter
string
filterByUrl
boolean
forceFilter
string
ignoreFilters
boolean
language
string
theme
string
userEmail
string
userFirstName
string
userId
string
userLastName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_FEEDS

Tool to retrieve the url for your feed. use when you need to embed or access your standalone feed.

Action Parameters

filter
string
filterByUrl
boolean
forceFilter
string
language
string
theme
string
userEmail
string
userFirstName
string
userId
string
userLastName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_FEED_URL

Tool to retrieve the url for your personalized feed. use after setting segmentation or language options to embed or redirect users.

Action Parameters

filter
string
filterByUrl
boolean
forceFilter
string
language
string
theme
string
userEmail
string
userFirstName
string
userId
string
userLastName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

notificationId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_NOTIFICATIONS

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

Action Parameters

category
string
dateFrom
string
filter
string
filterUrl
string
forceFilter
string
ignoreFilters
boolean
ignoreRequestDetails
boolean
language
string
markAsRead
boolean
maxResults
integer
page
integer
saveViews
boolean
traceableLinks
boolean
userEmail
string
userFirstName
string
userId
string
userLastName
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_POSTS

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_GET_POST_COMMENTS

Tool to retrieve comments for a specific post. use after identifying the post id to list its comments.

Action Parameters

dateFrom
string
dateTo
string
language
string
maxResults
integer
page
integer
postId
integerRequired
search
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

dateFrom
string
dateTo
string
maxResults
integer
page
integer
postId
integerRequired
reaction
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BEAMER_PING

Tool to ping the beamer api. use when verifying api key authentication before making further requests.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired