Beamer is a no-code product communication and user engagement platform that helps product, marketing, and customer success teams announce updates, collect customer feedback, run NPS surveys, and create in-app notifications. The Beamer REST API exposes posts (announcements and changelog entries), feature requests, feedback comments, reactions, votes, NPS responses, and unread counts, enabling integrations to read engagement data into a warehouse or analytics tool and to programmatically create, update, or delete posts and feature requests from upstream systems.
Power end-to-end data operations for your Beamer API with Nexla. Our bi-directional Beamer connector is purpose-built for Beamer, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Beamer or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Beamer workflows fast, secure, and fully governed.
Features
Type: API
SourceDestination
Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
The Beamer REST API uses API key authentication. Every request to the Beamer API must include your account's API key in the Beamer-Api-Key HTTP header — unauthenticated requests are rejected. Before creating a credential in Nexla, retrieve the API key from your Beamer account.
Click the gear icon (Settings) in the bottom-left corner of the Beamer dashboard, or navigate directly to app.getbeamer.com/settings#api.
Select API from the left-hand settings menu. Beamer displays your account's API key in this section.
Copy the API Key value, and store it securely. This key grants full access to your Beamer account data, so it should be treated like a password.
If your API key has been exposed or you want to rotate it, use the rotate option in the API settings section. Rotating the key invalidates the previous value, so any existing integrations using the old key will need to be updated.
For complete information about the Beamer API and its authentication model, see the Beamer API documentation.
Important
The Beamer API key grants full access to your account data and the ability to create, update, or delete posts and feature requests. Store it in a secure secret manager, never commit it to source control, and rotate it immediately if you suspect it has been exposed.
The Beamer API enforces a rate limit of 30 requests per second for paid accounts, in addition to monthly request limits that vary by plan. When configuring Nexla data flows that fan out to many Beamer endpoints (for example, listing posts and then fetching reactions or feedbacks per post), consider these limits when sizing batches and scheduling cadence.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Beamer API Key in the API Key field. This is the value copied from the API section of the Beamer settings page. Nexla will automatically send this value in the Beamer-Api-Key header on every API call made with this credential.
The API Key is stored as a secret in Nexla. It is never displayed back after saving and cannot be retrieved — only re-entered or rotated.
Click the Save button at the bottom of the overlay to save the configured credential. Nexla validates the credential by issuing a test request to the Beamer API; a failed validation indicates the key is invalid, has been rotated, or lacks access to the account. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the desired flow type, then select the Beamer connector tile from the list of available connectors, select the credential that will be used to connect to the Beamer instance, and click Next; or, create a new Beamer credential for use in this flow. Beamer sources can be configured using the pre-built endpoint templates below, or configured manually to ingest data from endpoints not included in the templates.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Beamer endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
List all posts
This endpoint returns a paginated list of every post (changelog entry or announcement) in your Beamer feed. Use it to sync your full release-note history into a warehouse or analytics tool, or to feed downstream notifications.
All filter parameters on this endpoint are optional. Leave them blank to return all posts using Beamer's default behavior.
To narrow the result set, enter values in the Filter, Force Filter, and Filter URL fields. These map to Beamer's segment-style filters that limit posts to a specific user audience or page URL.
To limit results by language, enter a Beamer language code (for example, en, es, fr) in the Language field.
To control publication state, set the Published field to true to return only published posts (or false for drafts), and set the Archived field to true to include archived posts.
To restrict results to a date range, enter the earliest date in the Date From field and the latest date in the Date To field, both in yyyy-MM-dd format.
This endpoint is paginated using Beamer's page and maxResults query parameters. Nexla advances the page index automatically and stops when an empty page is returned.
Get a single post
This endpoint retrieves the full record for a single post by its ID. Use it to enrich an existing dataset of post IDs with the latest content, translations, and segmentation rules.
Enter the post ID in the Id field. This is required. Post IDs can be obtained from the List all posts endpoint or from upstream Nexla data flows.
This endpoint returns a single post object (not an array). The path to data is set to the response root, so the post is treated as the record.
Count posts
This endpoint returns the total count of posts in your Beamer account that match the supplied filters. Use it for high-level reporting (for example, the number of changelog entries published in a quarter) without fetching the full post payloads.
All filter parameters are optional and mirror those on List all posts.
To narrow the count, enter values in the Filter, Force Filter, Filter URL, Published, or Archived fields.
To restrict the count to a date range, enter the earliest date in the Date From field and the latest date in the Date To field, both in yyyy-MM-dd format.
The response is a single object with a count property; the template sets the path to data to $.count so each run produces one numeric record.
Count unread posts
This endpoint returns the number of unread posts that would appear in the Beamer feed for a specific user. Use it to power "what's new" badges in a custom UI or to monitor engagement per user.
To identify the user, populate one or more of the User ID, User First Name, User Last Name, and User Email fields. Beamer matches the user using the same logic as the embedded widget.
To narrow which posts are considered, enter values in the Filter, Force Filter, Filter By URL, and Language fields.
To restrict the count to posts created on or after a given date, enter the date in the Date From field in yyyy-MM-dd format.
Like Count posts, the response is a single object with a count property. The template path to data is $.count.
Get feed URL
This endpoint returns the personalized Beamer feed URL for a given user and filter set. Use it to deep-link a user into their feed from an external app, email, or chat message.
To personalize the URL, populate one or more of the User ID, User First Name, User Last Name, and User Email fields. Beamer uses these values to compute which posts the user has already seen.
To restrict the feed to a subset of posts, enter values in the Filter, Force Filter, Filter By URL, and Language fields.
Pair this endpoint with a downstream messaging destination (email, Slack, SMS) to send each user a direct link to their personalized changelog.
List all feedbacks
This endpoint returns a paginated list of feedback comments left by users on a specific post. Use it to sync qualitative feedback into a warehouse, run sentiment analysis on comment text, or feed product-management tools.
Enter the post ID whose comments should be returned in the Post ID field. Post IDs can be obtained from the List all posts endpoint.
To restrict results to a date range, enter the earliest comment date in the Date From field and the latest in the Date To field, both in yyyy-MM-dd format.
This endpoint is paginated. Pair it with the List all posts endpoint as an upstream source (using a lookup-based macro on Post ID) to harvest comments for every post in your Beamer account.
Count feedbacks
This endpoint returns the total count of feedback comments on a specific post. Use it for engagement reporting (for example, comments per release) without fetching the full comment payloads.
Enter the post ID in the Post ID field.
To restrict the count to a date range, enter values in the Date From and Date To fields in yyyy-MM-dd format.
Response is a single object with a count property; the template path to data is $.count.
List Reactions
This endpoint returns a paginated list of reactions (likes, emoji responses) left on a specific post. Use it to track positive sentiment per release or to identify high-engagement announcements.
Enter the post ID in the Post ID field. Post IDs can be obtained from the List all posts endpoint.
To restrict results to a date range, enter the earliest reaction date in the Date From field and the latest in the Date To field, both in yyyy-MM-dd format.
Count Reactions
This endpoint returns the count of reactions received on a specific post. Use it for high-level engagement reporting.
Enter the post ID in the Post ID field.
To restrict the count to a date range, enter values in the Date From and Date To fields in yyyy-MM-dd format.
Response is a single object with a count property; the template path to data is $.count.
List Feature Requests
This endpoint returns a paginated list of feature requests submitted to your Beamer account. Use it to sync your roadmap input into a product-management tool, prioritize requests by vote count, or build dashboards on feedback themes.
To filter by status, enter the desired status in the Filter field — typical values include open, closed, and under_review.
To restrict results to a date range, enter the earliest request date in the Date From field and the latest in the Date To field, both in yyyy-MM-dd format.
This endpoint is paginated. The template advances Beamer's page parameter automatically and stops when an empty page is returned.
Get Feature Request
This endpoint retrieves a single feature request by its ID, including its title, description, status, and vote count. Use it to enrich an existing dataset of feature request IDs with the full payload.
Enter the feature request ID in the Id field. This is required. Request IDs can be obtained from the List Feature Requests endpoint.
The response is a single object. The template path to data is $, so the feature request is treated as the record.
Count Feature Requests
This endpoint returns the count of feature requests in your Beamer account, optionally narrowed by status and date range. Use it for high-level roadmap reporting without fetching every request payload.
To filter by status, enter the desired status in the Filter field (for example, open, closed, or under_review).
To restrict the count to a date range, enter values in the Date From and Date To fields in yyyy-MM-dd format.
Response is a single object with a count property; the template path to data is $.count.
List Votes
This endpoint returns a paginated list of votes cast on a specific feature request. Use it to attribute upvotes/downvotes to specific users and feed prioritization frameworks downstream.
Enter the feature request ID in the Request ID field. Request IDs can be obtained from the List Feature Requests endpoint.
To restrict results to a date range, enter the earliest vote date in the Date From field and the latest in the Date To field, both in yyyy-MM-dd format.
Get NPS Data
This endpoint returns NPS (Net Promoter Score) survey responses collected by Beamer. Use it to sync NPS data into a warehouse or BI tool, compute trends over time, and segment promoters/detractors by user attributes.
No configuration is required for this endpoint beyond selecting it — all NPS responses on the account are returned automatically.
This endpoint is paginated. The template uses Beamer's page and maxResults query parameters; Nexla advances the page index automatically and stops when an empty page is returned.
Ping API
This endpoint verifies that your API key is valid and that the Beamer API is reachable. Use it as a lightweight health check in monitoring flows.
No configuration is required. The endpoint takes no parameters and returns a small response payload.
The Ping endpoint uses the POST HTTP method even though it carries no body. This is a Beamer-specific convention.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Beamer data sources can also be manually configured to ingest data from any valid Beamer API endpoint not covered by the pre-built templates, including chained calls that fetch feedbacks, reactions, or votes per post. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
All Beamer API URLs use the base https://api.getbeamer.com/v0/ followed by the resource path (for example, https://api.getbeamer.com/v0/posts or https://api.getbeamer.com/v0/requests). Most list endpoints return a top-level JSON array, so the path to data is $[*]; single-object endpoints (such as /posts/{'{id}'}) use $; and count endpoints use $.count. Beamer expects the yyyy-MM-dd date format for the dateFrom and dateTo query parameters. The Beamer-Api-Key authentication header is added automatically from your credential — you do not need to add it as a request header.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Beamer data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.
Click the + icon on the Nexset that will be sent to the Beamer destination, and select the Send to Destination option from the menu. Select the Beamer connector from the list of available destination connectors, then select the credential that will be used to connect to the Beamer account, and click Next; or, create a new Beamer credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Beamer endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.
Create a new post
This endpoint creates a new post (changelog entry or announcement) in your Beamer account. Use it to publish release notes programmatically from a CI/CD pipeline, ticketing system, or upstream content tool.
Each record in the upstream Nexset must include a title and content field. The Beamer template wraps each value into the language-keyed array format that Beamer expects (for example, the value of title is sent as ["My title"]).
Include a language attribute on each record (for example, en, es, fr) to indicate which language the title and content are in. Beamer uses this for multi-language feeds.
Optionally include a category attribute (for example, new, improvement, fix, coming_soon, announcement, other) to tag the post in Beamer.
The full record is sent as the JSON body of the POST /posts call. Use the Nexla transform layer to shape upstream attributes into the field names expected by Beamer.
Beamer signals success via HTTP 200 with the new post payload. Enable the Response Webhook option (in the Configure Manually section below, after switching to the Advanced tab) to capture the new post ID into a Nexla webhook source for downstream branching.
Update a post
This endpoint updates an existing post — useful for syncing edits to release notes, correcting copy after publication, or programmatically translating posts.
Enter the post ID in the Id field. The Beamer template substitutes this value into the URL path. To drive the destination directly from upstream records, reference an attribute (for example, {'{{id}}'}) so each record updates its corresponding post.
The body of each PUT call carries the new title, content, language, and category values. Include only the fields that should be changed.
Updating a post does not change its publication date or audience targeting. Use the Beamer UI to adjust segmentation or scheduling for a post.
Delete a post
This endpoint permanently deletes a post from your Beamer account. The deletion is irreversible and removes the post from every user's feed.
Enter the post ID in the Id field. The Beamer template substitutes this value into the URL path. To drive the destination directly from upstream records, reference an attribute (for example, {'{{id}}'}) so each record deletes its corresponding post.
The DELETE /posts/{'{id}'} call carries no body.
Because deletion is irreversible, validate upstream data carefully before activating this destination. Consider routing through a Nexla transform that filters to only the posts that should genuinely be deleted.
Create Feature Request
This endpoint creates a new feature request in your Beamer account. Use it to seed feature requests from an external roadmap tool, customer support ticket, or upstream feedback channel.
Each record in the upstream Nexset must include a title and content field describing the request. The Beamer template wraps each value into the language-keyed array format Beamer expects.
Include a language attribute on each record (for example, en) to indicate the language of the title and content.
Include a visible attribute (boolean true or false) to control whether the request appears in the public feedback board immediately.
Optionally include a category attribute to group requests under a Beamer category.
The full record is sent as the JSON body of the POST /requests call.
Set visible to false when seeding requests from internal tools that should be reviewed before being shown to end users.
Update Feature Request
This endpoint updates an existing feature request — useful for syncing status changes, edits, or moderator notes from a downstream roadmap tool back into Beamer.
Enter the feature request ID in the Id field. The Beamer template substitutes this value into the URL path. To drive the destination directly from upstream records, reference an attribute (for example, {'{{id}}'}) so each record updates its corresponding feature request.
The body of each PUT call carries the updated title, content, language, visible, and category values. Include only the fields that should be changed.
Delete Feature Request
This endpoint permanently deletes a feature request from your Beamer account, removing it from the public feedback board along with all associated votes and comments.
Enter the feature request ID in the Id field. The Beamer template substitutes this value into the URL path. To drive the destination directly from upstream records, reference an attribute (for example, {'{{id}}'}) so each record deletes its corresponding feature request.
The DELETE /requests/{'{id}'} call carries no body.
Deletion is irreversible — the request and its votes and comments cannot be recovered. Validate upstream data carefully before activating this destination.
Beamer destinations can also be manually configured to send data to any valid Beamer API endpoint not covered by the pre-built templates, including custom URL patterns, header overrides, or batch settings. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.
The Beamer API expects application/json for all write endpoints. All URLs use the base https://api.getbeamer.com/v0/ followed by the resource path; for update or delete operations, include the post or request ID at the end of the URL (for example, {'https://api.getbeamer.com/v0/posts/{id}'}). The Beamer-Api-Key header is added automatically from your credential, and Content-Type: application/json is added based on the selected Content Format. Beamer does not support batched create/update calls — each post or feature request is sent as its own request — so record batching is best left disabled, and large loads should be paced against Beamer's limit of 30 requests per second. Enable the response webhook to capture the newly created post or feature request ID returned by Create a new post and Create Feature Request.
Important
Test payloads sent to write endpoints (such as Create a new post, Update a post, Delete a post, or any feature request write endpoint) will make real, irreversible changes in your Beamer account. Use a sandbox or test Beamer account before sending test data against a production Beamer account.
Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Beamer, open the destination resource menu, and select Activate.
The Nexset data will not be sent to Beamer until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
