Skip to main content

Beamer Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Beamer location.
beamer_api.png

Beamer

Create a Beamer Destination​

  1. Click the + icon on the Nexset that will be sent to the Beamer destination, and select the Send to Destination option from the menu.

  2. 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.

  3. In Nexla, Beamer destinations can be created using pre-built endpoint templates, which expedite destination setup for common Beamer endpoints. Each template is designed specifically for the corresponding Beamer endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Beamer destinations can also be configured manually, allowing you to send data to Beamer endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Beamer endpoints. Each template is designed specifically for the corresponding Beamer endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

Beamer destinations can be manually configured to send data to any valid Beamer API endpoint. Manual configuration provides maximum flexibility for endpoints not covered by pre-built templates, including custom URL patterns, header overrides, or batch settings.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Beamer API after each call to a new Nexla webhook data source. This is particularly useful for capturing the new post ID returned by Create a new post or the new feature request ID returned by Create Feature Request.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Beamer API from the Method pulldown menu. Common methods for Beamer write endpoints include:

    • POST: For creating resources (for example, POST /posts, POST /requests)
    • PUT: For updating resources (for example, PUT /posts/{'{id}'}, PUT /requests/{'{id}'})
    • DELETE: For removing resources (for example, DELETE /posts/{'{id}'}, DELETE /requests/{'{id}'})

Data Format​

  1. Select the format in which the Nexset data will be sent to the Beamer API from the Content Format pulldown menu. The Beamer API expects application/json for all write endpoints, so JSON is the appropriate choice for every Beamer destination.

API Endpoint URL​

  1. Enter the URL of the Beamer API endpoint to which you want to send the Nexset data in the URL field. All Beamer API 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 — Nexla macros can substitute the ID from each upstream record (for example, {'https://api.getbeamer.com/v0/posts/{id}'}).

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The Beamer-Api-Key authentication header is added automatically based on your Beamer credential, and Content-Type: application/json is added based on the selected Content Format.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Beamer destination, select the attributes from the Exclude Attributes pulldown menu. This is useful for stripping internal Nexla bookkeeping fields, or for omitting upstream IDs that Beamer would reject as unknown.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

The Beamer API does not natively support batched create/update calls — each post or feature request is created with its own request. Record batching in Nexla is therefore best left disabled for Beamer destinations. Combined with Beamer's 30 requests-per-second rate limit, large unbatched loads should be paced accordingly.

  1. To override the default and group records into a single batched payload anyway, check the box next to Would you like to batch your records together?.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Beamer API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and downstream-process the returned post or feature request IDs.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

    Enabling the response webhook is particularly useful for Create a new post and Create Feature Request, both of which return the newly created resource ID in their response — these IDs are often needed by downstream Nexla flows.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Beamer API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Beamer API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Beamer API using the current settings.

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.

Save & Activate the Destination​

  • 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.