Beamer
Beamer in ZBrain Flow is a platform designed to help you engage users with targeted in-app messages and announcements. It enables you to create posts, collect feedback, and foster user interaction—making it easier to keep your audience informed and involved with your product updates or community news.
How to Integrate Beamer with ZBrain Flow?
Click the “+” Button in the Flow Open your ZBrain Flow and select the plus sign (+) to add a new step.
Search for “Beamer” Type “Beamer” in the search bar to view the available tasks.
Choose the Desired Task Select the specific Beamer task you want to include in your Flow.
Tasks you can perform on Beamer:
Create Beamer Post: Publish a new post to your Beamer feed, sharing updates, news, or announcements with your users.
Create New Feature Request: Allow users to submit ideas or suggestions for your product, collecting valuable feedback directly through Beamer.
Create New Comment: Add comments to existing posts or feature requests, fostering dialogue and engagement within your user community.
Create New Vote: Let users upvote or downvote feature requests and posts, helping you prioritize development based on community interest.
Custom API Call: Make a tailored API request to Beamer’s endpoints, giving you greater control and flexibility for advanced use cases.
Create Beamer Post
Publish a new post to your Beamer feed, sharing updates, news, or announcements with your users.
How to Configure the “Create Beamer Post” Action in ZBrain Flow?
Step 1: Add the “Create Beamer Post” Step
Insert a New Step
In your flow, click the + button to add a new step.
Search for “Beamer”
Type “Beamer” in the search bar and select Create Beamer Post from the available actions.
Step 2: Create a Beamer Connection
Go to Connections
In ZBrain Flow, navigate to the API Key and Create Connection or select an existing connection.
Enter Connection Details
Connection Name: Give your connection a recognizable name (e.g., “Beamer”).
API Key: Paste the API key from your Beamer account settings.
Save the Connection
Click Save to finalize your Beamer connection. Your new connection is now ready to use.
Step 3: Configure the “Create Beamer Post” Action
Title
Provide a title for your Beamer post. This is the main heading users will see.
Description
Enter a description or body text for the post. You can include details, links, or other relevant info.
Category (Optional)
Select a category to help organize and filter your posts within Beamer.
Show in Widget / Standalone (Optional)
Decide whether the post should appear in the Beamer Widget (in-app) or in a Standalone view.
Toggle the relevant option and configure it as needed.
Enable Feedback, Reactions, Social Share, Auto Open, Push Notifications (Optional)
Enable or disable each feature by toggling the switch. For instance:
Enable Feedback: Allows users to leave feedback on the post.
Enable Reactions: Lets users respond with emojis.
Enable Social Share: Provides sharing options.
Enable Auto Open: Automatically opens the post when users access the widget.
Enable Push Notifications: Sends a push notification if your Beamer plan supports it.
User Email (Optional)
Enter the email of the user posting the update if you want to track or attribute the post to a specific account.
Step 4: Save and Test
Save Your Configuration
After filling in all required fields, click Save or Done.
Run the Flow
Trigger your flow to confirm that the “Create Beamer Post” action works correctly.
Verify in Beamer
Log in to your Beamer account and check that the new post has been added to your feed with the correct title, description, and settings.
Create New Feature Request
Allow users to submit ideas or suggestions for your product, collecting valuable feedback directly through Beamer.
How to Configure the “Create New Feature Request” Action in Beamer Using ZBrain Flow?
Step 1: Add the “Create New Feature Request” Step
Insert a New Step
In your flow, click the + button to add a new step.
Search for “Beamer”
Type “Beamer” in the search bar and select Create New Feature Request from the available actions.
Step 2: Create a Beamer Connection
Go to Connections
In ZBrain Flow, navigate to the API Key and Create Connection or select an existing connection.
Enter Connection Details
Connection Name: Give your connection a recognizable name (e.g., “Beamer”).
API Key: Paste the API key from your Beamer account settings.
Save the Connection
Click Save to finalize your Beamer connection. Your new connection is now ready to use.
Step 3: Configure the “Create New Feature Request” Action
Title
Provide a title for the feature request. This will appear as the main heading in Beamer.
Description
Enter a detailed description of the feature request. This is where you can include context, use cases, or any relevant details.
Visibility (Optional)
Choose how visible this feature request should be (e.g., Public, Private, or any other visibility settings offered by Beamer).
Category (Optional)
Select a category to group or classify your feature request within Beamer.
Status (Optional)
Indicate the current status of the request (e.g., Open, Planned, In Progress, Completed).
User Email (Optional)
Provide an email address if you want to associate the feature request with a specific user or contributor.
Step 4: Save and Test
Save Your Configuration
Once you’ve entered all required fields, click Save or Done.
Run the Flow
Trigger your flow to confirm that the “Create New Feature Request” action successfully creates a new entry in Beamer.
Verify in Beamer
Log in to your Beamer account and check that the new feature request has been added with the correct title, description, and settings.
Create New Comment
Add comments to existing posts or feature requests, fostering dialogue and engagement within your user community.
How to Configure the “Create a New Comment” Action in Beamer Using ZBrain Flow?
Step 1: Add the “Create a New Comment” Step
Insert a New Step
In your flow, click the + button to add a new step.
Search for “Beamer”
Type “Beamer” in the search bar and select Create a new comment from the available actions.
Step 2: Create a Beamer Connection
Go to Connections
In ZBrain Flow, navigate to the API Key and Create Connection or select an existing connection.
Enter Connection Details
Connection Name: Give your connection a recognizable name (e.g., “Beamer”).
API Key: Paste the API key from your Beamer account settings.
Save the Connection
Click Save to finalize your Beamer connection. Your new connection is now ready to use.
Step 3: Configure the “Create a New Comment” Action
ID of the Feature Request or Post
Enter the unique ID of the feature request or post you want to comment on.
This ID can typically be retrieved from previous steps in your flow (e.g., “Create New Feature Request,” “List Rows,” or “Create Beamer Post”) or from your Beamer dashboard.
User ID (Optional)
If you want to attribute the comment to a specific user, provide their User ID.
This is helpful for tracking and engagement metrics.
Text
Write the content of your comment. You can also map dynamic data from earlier steps (e.g., user input, AI-generated text).
User Email (Optional)
Enter the email address of the user making the comment, if you’d like to store or track this information in Beamer.
Step 4. Save and Test
Save Your Configuration
After entering all necessary fields, click Save or Done.
Run the Flow
Trigger the flow to confirm that the “Create a new comment” action is successful.
Verify in Beamer
Log in to your Beamer account and check the relevant feature request or post to ensure the comment has been added correctly.
Create New Vote
Let users upvote or downvote feature requests and posts, helping you prioritize development based on community interest.
How to Configure the “Create a New Vote” Action in Beamer Using ZBrain Flow?
Step 1: Add the “Create a New Vote” Step
Insert a New Step
In your flow, click the + button to add a new step.
Search for “Beamer”
Type “Beamer” in the search bar and select Create a new vote from the available actions.
Step 2: Create a Beamer Connection
Go to Connections
In ZBrain Flow, navigate to the API Key and Create Connection or select an existing connection.
Enter Connection Details
Connection Name: Give your connection a recognizable name (e.g., “Beamer”).
API Key: Paste the API key from your Beamer account settings.
Save the Connection
Click Save to finalize your Beamer connection. Your new connection is now ready to use.
Step 3: Configure the “Create a New Vote” Action
Feature ID
Enter the ID of the feature request (or post) you want users to vote on.
This ID can be retrieved from previous steps (e.g., “Create New Feature Request,” “List Rows,” or “Create Beamer Post”) or from your Beamer dashboard.
User Firstname (Optional)
Provide the first name of the user casting the vote, if applicable.
Useful for personalization and tracking in Beamer.
User Email (Optional)
Enter the email of the user casting the vote.
Helps track user activity and can tie votes to specific individuals.
Step 4: Save and Test
Save Your Configuration
After filling in all necessary fields, click Save or Done.
Run the Flow
Trigger the flow to confirm that the “Create a new vote” action is successful.
Verify in Beamer
Log in to your Beamer account and check the relevant feature request or post to ensure the new vote has been registered.
Custom API Call
Make a tailored API request to Beamer’s endpoints, giving you greater control and flexibility for advanced use cases.
How to Configure the “Custom API Call” Action with Beamer in ZBrain Flow?
Step 1: Add the “Custom API Call” Step
Insert a New Step
In your flow, click the + button to add a new step.
Search for “Beamer”
Type “Beamer” in the search bar and select Custom API Call from the available actions.
Step 2: Create a Beamer Connection
Go to Connections
In ZBrain Flow, navigate to the API Key and Create Connection or select an existing connection.
Enter Connection Details
Connection Name: Give your connection a recognizable name (e.g., “Beamer”).
API Key: Paste the API key from your Beamer account settings.
Save the Connection
Click Save to finalize your Beamer connection. Your new connection is now ready to use.
Step 3: Configure the Request Details
URL
Enter the Beamer API endpoint you wish to call (e.g.,
https://api.getbeamer.com/v0/...).This can be a full URL or a relative path, depending on how your connection is set up.
Method
Select the HTTP method (GET, POST, PUT, PATCH, DELETE) based on your desired action.
Refer to Beamer’s API documentation for the correct method and endpoint.
Headers
By default, your Authorization header (with the API key) is typically handled by the connection.
Add any additional headers if required by your specific endpoint (e.g.,
Content-Type: application/json).
Query Parameters (Optional)
If your endpoint requires query parameters (e.g.,
?page=2or?status=active), add them here.Click Add Item to include each key-value pair.
Body (Optional or Required)
Provide the JSON body in this field for POST, PUT, or PATCH requests.
Include any required fields or data structures based on the Beamer API documentation.
No Error on Failure (Toggle)
Enable this if you want the flow to continue, even if the API call returns an error.
Timeout (in seconds) (Optional)
Specify how long the step should wait before timing out. If left blank, ZBrain Flow uses a default timeout.
Step 4. Save and Test
Save Your Configuration
Once all required fields are set, click Save or Done to confirm.
Run the Flow
Test your flow to ensure that the “Custom API Call” step communicates properly with Beamer.
Inspect the Output
Check the response to confirm that the API call returned the expected data or performed the desired action.
Last updated