NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Beamer

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.

NotificationsProduct ManagementWeb del proveedor
Acciones
11
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (11)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Count PostsBEAMER_COUNT_POSTSAcción

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

Parámetros de entrada

  • dateTostring

    Only count posts published before this date (ISO-8601).

  • filterstring

    Count posts with a matching segmentation filter. [Pro plan and up]

  • userIdstring

    User ID to use with filterByUserId only.

  • expiredboolean

    Count only expired (true) or non-expired (false) posts. [Starter plan and up]

  • archivedboolean

    Count only archived (true) or non-archived (false) posts.

  • categorystring

    Only count posts in this category.

  • dateFromstring

    Only count posts published after this date (ISO-8601).

  • languagestring

    Only count posts with translations in this language (ISO-639 two-letter). [Starter plan and up]

  • filterUrlstring

    Include posts matching this segmentation URL. [Pro plan and up]

  • publishedboolean

    Count only published (true) or draft (false) posts.

  • forceFilterstring

    Only count posts that match this segmentation filter. [Pro plan and up]

  • ignoreFiltersboolean

    If true, ignore segmentation filters (requires permission).

  • filterByUserIdboolean

    If true, include single-user posts matching userId. [Scale plan]

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CategoryBEAMER_GET_CATEGORYAcción

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.

Parámetros de entrada

  • category_idstringObligatorio

    Unique identifier of the category to retrieve. Basic categories include 'new', 'improvement', 'fix', 'comingsoon', 'announcement', and 'other'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FeedBEAMER_GET_FEEDAcción

Tool to retrieve the url for your standalone feed. use after embedding to fetch the feed link for embedding or sharing.

Parámetros de entrada

  • themestring

    Theme class for appearance customization via CSS. Only available on Pro plan and up.

  • filterstring

    Retrieve posts with a matching segmentation filter. Only available on Pro plan and up.

  • userIdstring

    ID of the user viewing the feed (for analytics).

  • languagestring

    Two-letter ISO-639 code to retrieve feed in a specific language. Only available on Starter plan and up.

  • userEmailstring

    Email of the user viewing the feed (for analytics).

  • filterByUrlboolean

    Whether to apply URL filtering to the feed. Only available on Pro plan and up.

  • forceFilterstring

    Only retrieve posts matching this segmentation filter. Only available on Pro plan and up.

  • userLastNamestring

    Last name of the user viewing the feed (for analytics).

  • ignoreFiltersboolean

    If true, all posts will be retrieved, ignoring segmentation filters. Requires special API-key permission.

  • userFirstNamestring

    First name of the user viewing the feed (for analytics).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get FeedsBEAMER_GET_FEEDSAcción

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

Parámetros de entrada

  • themestring

    Theme class to use for appearance customization via CSS. (Pro plan and up)

  • filterstring

    Retrieve posts with a matching segmentation filter. (Pro plan and up)

  • userIdstring

    ID of the user viewing the feed (for analytics).

  • languagestring

    ISO-639 two-letter code to retrieve the feed in a specific language.

  • userEmailstring

    Email of the user viewing the feed (for analytics).

  • filterByUrlboolean

    Whether to apply URL filtering to the feed. (Pro plan and up)

  • forceFilterstring

    Only retrieve posts that match this segmentation filter. (Pro plan and up)

  • userLastNamestring

    Last name of the user viewing the feed (for analytics).

  • userFirstNamestring

    First name of the user viewing the feed (for analytics).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Feed URLBEAMER_GET_FEED_URLAcción

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

Parámetros de entrada

  • themestring

    Theme class to use for appearance customization via CSS. Only available on Pro plan and up.

  • filterstring

    Retrieve posts with a matching segmentation filter. Only available on Pro plan and up.

  • userIdstring

    ID of the user viewing the feed (for analytics).

  • languagestring

    ISO-639 two-letter code to retrieve the feed in a specific language. Only available on Starter plan and up.

  • userEmailstring

    Email of the user viewing the feed (for analytics).

  • filterByUrlboolean

    Whether to apply URL filtering to the feed. Only available on Pro plan and up.

  • forceFilterstring

    Only retrieve posts that match this segmentation filter. Only available on Pro plan and up.

  • userLastNamestring

    Last name of the user viewing the feed (for analytics).

  • userFirstNamestring

    First name of the user viewing the feed (for analytics).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NotificationBEAMER_GET_NOTIFICATIONAcción

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

Parámetros de entrada

  • notificationIdintegerObligatorio

    ID of the notification to retrieve (post ID).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NotificationsBEAMER_GET_NOTIFICATIONSAcción

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

Parámetros de entrada

  • pageinteger

    Page number for pagination of results.

  • filterstring

    Retrieve notifications matching this segmentation filter. (Pro plan+)

  • userIdstring

    Analytics: ID of the viewing user (Scale plan+).

  • categorystring

    Only notifications in this category.

  • dateFromstring

    Only notifications published after this ISO-8601 timestamp.

  • languagestring

    Two-letter ISO-639 code: only notifications in this language. (Starter plan+)

  • filterUrlstring

    Include notifications matching this segmentation URL. Supports wildcards. (Pro plan+)

  • saveViewsboolean

    Whether to record view counts for the retrieved notifications.

  • userEmailstring

    Analytics: email of the viewing user.

  • markAsReadboolean

    Mark retrieved notifications as read. (default true)

  • maxResultsinteger

    Maximum number of notifications to return (max 10).

  • forceFilterstring

    Only retrieve notifications that match this segmentation filter exactly. (Pro plan+)

  • userLastNamestring

    Analytics: last name of the viewing user.

  • ignoreFiltersboolean

    Ignore segmentation filters entirely. Requires special API-key permission.

  • userFirstNamestring

    Analytics: first name of the viewing user.

  • traceableLinksboolean

    Convert links to traceable URLs for click analytics.

  • ignoreRequestDetailsboolean

    Ignore IP/browser/geolocation details when retrieving notifications.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Post CommentsBEAMER_GET_POST_COMMENTSAcción

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

Parámetros de entrada

  • pageinteger

    Page number for pagination (>=1)

  • dateTostring

    Retrieve comments published before this ISO-8601 date

  • postIdintegerObligatorio

    ID of the post to retrieve comments from

  • searchstring

    Retrieve comments containing this substring in their text

  • dateFromstring

    Retrieve comments published after this ISO-8601 date

  • languagestring

    ISO-639 two-letter code to filter comments by language

  • maxResultsinteger

    Maximum number of comments to return (1-10)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Post ReactionsBEAMER_GET_POST_REACTIONSAcción

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.

Parámetros de entrada

  • pageinteger

    Page number for pagination (>=1)

  • dateTostring

    Only include reactions before this ISO-8601 timestamp

  • postIdintegerObligatorio

    ID of the post to retrieve reactions from

  • dateFromstring

    Only include reactions after this ISO-8601 timestamp

  • reactionstringenum

    Filter reactions by type: positive, neutral, or negative

    positiveneutralnegative
  • maxResultsinteger

    Maximum number of reactions to return (1-10)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PostsBEAMER_GET_POSTSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Ping APIBEAMER_PINGAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not