Initial Setup of the Widget Builder

Learn how to install the Widget Builder as an administrator in Staffbase.

Prerequisites

Ensure the following prerequisites are met:

• The current Staffbase user has the role of an administrator.
• The feature flag oauthclients_settings is enabled. You can verify this by checking if there is an OAuth Configurations section in the left navigation panel of the Staffbase Studio.
• A one-time registration of the Widget Builder is required in your Staffbase platform to establish a permanent connection between the Widget Builder and Staffbase.

Follow these steps to complete the setup

1. Visit the Widget Builder App
   Go to the Widget Builder (app.widgetbuilder.de) and click on Sign up.

   

2. Connect to your Staffbase platform
   Enter your information and provide the Staffbase URL of your environment and click on the Connect button.

   

3. Automatic redirection to Staffbase Studio
   You will be redirected to the Studio of your Staffbase platform. Click on the Create & Redirect button in the pre-filled SPA dialog that appears.

   

4. OAuth configuration setup
   The OAuth configuration for the Widget Builder will be automatically created in your Staffbase platform. You will be redirected to the Widget Builder website to finish the registration process.

   

5. Complete the Widget Installation
   After the OAuth configuration is set up, the Widget Bundle is automatically added to your Staffbase platform. If this does not happen, follow the detailed instructions in the Manual Widget Installation guide to add the Widget Bundle manually.

   

Next Steps

Once the setup is complete, you can:

• Explore the Widget Builder Basics to create your first custom widget
• Check out the Getting Started for a quick guide on how to use the Widget Builder
• Learn about Built-in Widgets that are available out of the box