End users are an integral part of your world. Learn how to add users via CSV file upload or manual account creation, and watch your Breakroom come to life.
There are a number of different ways that you can invite users to join you in Breakroom. You can:
Create multiple user accounts simultaneously by uploading a CSV file
Create user accounts one at a time by manually editing your user records
Allow users to register their own account the first time they visit your world
Enable your existing single sign-on (SSO) service
Finally, if you're hosting a free or for-cost ticketed event in Breakroom, you'll want to take advantage of Eventbrite integration to make logistics a snap.
CSV files, or comma-separated values files, are spreadsheets containing relevant user information that can be uploaded to Breakroom through your Dashboard. Uploading a CSV file will create an account for each user listed in the spreadsheet, complete with password. You can also list important institutional information about each user, which may be displayed in their profile or in-world hovertext (the identifying text that appears above each user's head).
You can download a fresh, unpopulated CSV file by clicking on the file link below:
You can also download an unpopulated CSV file directly from your Dashboard. Click on the Manage Users tab, and then click the Import Users button. A pop-up menu will appear. Click on the link that says "Download CSV Model," and save the file to your computer.
You can open and edit CSV files using any commonly available spreadsheet software, such as Microsoft Excel or Google Sheets. When you open the blank CSV file linked above, you will see a series of fields where you can enter required or optional information.
Required information includes:
Display Name: This is the name that serves to identify the user while they are in-world. It may appear in the identification tag that hovers over the user's avatar, as well as in the user's profile. Display names can be changed at any time by the world Owner or an Administrator.
Username: This is a permanent username that serves to identify the account. It can also be used in place of the user's email address during the login process.
Email address: Please enter an email address to which the user has full access, in case they need to change their password.
Password: Please enter a complex, unique password of six or more characters.
Type: Please confirm the user's world-level permissions type. (If you do not enter a value in this field, the user type will default to Guest.)
Usernames can contain a maximum of 32 characters. Only alpha-numeric characters, spaces, underscores and dashes can be used. If you do not enter a custom username, one will be auto-generated from the user's display name.
Optional fields include:
Title: This is optional information that will also appear in the hover tag displayed above the user's head, as well as in their profile. For instance, you might use this field to identify a "Senior Delegate," or make it something fun like "Metaverse Wanderer."
Job Title: This refers to the user's actual job title. If you supply this information, it will be displayed in the user's hover tag and their profile.
Company: This is, of course, the company the user works for. If you supply this information, it will also be displayed in the user's hover tag and profile as described above.
Once you've entered at least the minimum required user data, you will need to save or export the document in CSV (.csv) format. You can change the document name if you like.
To upload a CSV file, navigate to the Manage Users tab of your Dashboard and click the Import Users button.
In the pop-up window that appears, click the "Upload file" field. This will launch a standard file import window. Locate the CSV file you want to upload on your computer, click on it, and then click the Open button.
If your CSV file contains any errors, the document will be rejected and those errors will be highlighted so you can make the necessary corrections. If no errors are detected, you will see the "CSV file verification succeeded" message displayed above. Click the Import CSV button to continue.
Once you've successfully imported your users, you will see them listed under the Manage Users tab. You can click the pencil icon located next to a user's name to manually edit their information, or click the trash can icon to remove them from your user list altogether.
If you need to locate a particular user or set of users in your user list, you can also make use of the following functions:
The search field in the upper left corner allows you to search for a name, email address, or specific user ID.
The "Search by status" drop-down menu allows you to display only those users who have a particular status (e.g. active, pending, etc).
The "Select user type" drop-down menu allows you to display only users of a certain type (e.g. Administrators, Developers, etc).
To download a CSV file containing all of your current user information, click the Export Users button.
Adding a user to your roster manually is as simple as filling out a text form. To begin, navigate to the Manage Users tab on your Dashboard and click the Add Users button.
A pop-up window will appear containing several information fields. To create a new user account, you will need to provide at least a Display Name, Username, email address, and password. You'll also need to choose a user type.
If you want to add more than one user during a single session, click the plus icon in the bottom left corner to generate an additional set of user information fields. When you are finished keying in your user data, click the Add User button.
User types correspond to world-level user permissions, and can be changed by clicking the pencil icon located to the right of a user's name and then selecting the type to be assigned. A detailed explanation of the different user types and step-by-step instructions for assigning user types are also available.
In addition to a user type, each user is also assigned a status. You can use the "Search by status" drop-down menu to display only the users assigned that particular status, and to narrow down your search for a specific user.
The status types are:
Active: The user's account is active and accessible to the user. They can log in to your world. If you have assigned them advanced world-level user permissions, they have access to the virtual tools they need (e.g. Curator).
Inactive: The user's account information is preserved, but they cannot currently log in to your world. See the section that follows for more information about activating and deactivating users.
Pending: The user's account is pending activation, and they have not yet logged in. This may be due to a lack of available seats.
Inactive users will not be displayed in your user list by default. To see your Inactive users, please use the "Search by status" drop-down menu to select the All or Inactive option.
Users can be deactivated individually or in bulk. When a user is deactivated, they will still appear under the Manage Users tab, with their user status changed to Inactive. They will no longer be able to log in to your world, and will no longer take up one of your account's seats.
To deactivate an individual user, click on the trash can icon located to the right of their name. The trash icon will then change to an undo icon. To reactivate the user, click the undo icon.
To deactivate or activate multiple users at once, check off each relevant name in your user list and then click the trash can icon or undo icon located in the top right above the user list.
If a user seems to disappear from your user list when you deactivate them, make sure that the "Search by status" drop-down menu is set to show All users or Inactive users. If it is set to any other option, you may not see your full user list.
When you reactivate an inactive user account, the account will default to Pending status and Guest type. You will need to update their world-level user role manually.
When self-registration is enabled, users who access your world through World Stream or a dedicated desktop app can sign up for their own account. Each user registration will take up one of your available seats, and users will be given the opportunity to pick a starter avatar from your default avatar collection.
You can enable or disable self-registration from your Dashboard by following the steps below.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the World Access tab.
Click the Self-Registration toggle to enable or disable self-registration.
If self-registration is disabled, you will need to import or manually create user accounts using the steps outlined above, or enable SSO.
Learn how to enable SSO on Breakroom and customize your end-user login experience.
By enabling single sign-on (SSO) on Breakroom, you can provide your users with a secure and simplified login process. Integrating your current identity management system with Breakroom takes only a few minutes, but has the potential to save you a lot of hassle.
In order to enable SSO, you will need to contract for services with an Identity Provider (IdP). Some IdPs to consider include Okta and Microsoft Azure.
To enable SSO within Breakroom, you will need to copy the parameters Breakroom provides and enter them into your IdP's SAML Signing Certificate generator. Your IdP will then provide you with a SAML Signing Certificate, which will include a metadata file containing additional information. You will need to enter this information into the Breakroom Dashboard in order to complete setup.
You can enable SSO within Breakroom by following the steps below.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the World Access tab.
Click the SSO Login toggle to enable SSO.
5. Once the SSO Login toggle is enabled, several additional sections will appear on your screen. Scroll down to the Identity Provider Setup section. 6. Here you will see two parameters provided in the form of links—the SSO URL and the SP Entity ID. You can click the copy icon located next to either of these parameters in order to copy it. 7. Enter these parameters into the SAML Signing Certificate generator on your IdP's website. Once your IdP finishes creating your SAML Signing Certificate, they will provide you with a metadata file.
9. Return to the Breakroom Dashboard and scroll to the Details Provided by your Identity Provider section. Enter the Entity ID, X.509 Certificate, and Sign-in URL parameters from the IdP metadata file into the relevant fields. 10. Click the Save button.
Upon enabling SSO, user accounts are not automatically generated in Breakroom, and you will not see any users appear under the Manage Users tab. Instead, Breakroom accounts will be generated as users log in. Each user account will occupy one of the available seats under your Breakroom account.
To disable SSO integration, simply click the SSO Login toggle again.
The World Access tab features a login panel preview, so you can see how your changes will appear on the World Stream landing page and the desktop app. You can also personalize your SSO button with a logo and custom text.
To customize the login panel, follow these steps.
Navigate to your Dashboard.
Click on the World Customization tab.
Click on the World Access tab.
First, choose which login methods will be available for your users.
Enable or disable self-registration.
Enable or disable SSO.
Enable or disable the standard login (Breakroom account email and password).
If you have chosen to enable SSO, you can then customize the SSO login button appearance.
In the Button Text field, enter the text you would like to appear on the button.
If you want to upload a custom logo for the SSO login button, click the Browse link in the Button Image field. This will launch a standard file import window on your computer. Locate the image file you want to use, click on it, and then click the Open button.
If you want to clear the current logo, click the Delete button.
When you are satisfied with your changes, click the Save button.
Learn how to assign Region Administrator and Moderator permissions to your teammates, and take full advantage of Breakroom's powerful region creation and event management tools.
There are two categories of special user permissions that you can assign to teammates, event coordinators, or end users—world-level permissions, and region-level permissions. It is important to note that these two categories are distinct, with their own separate spheres of influence and control. On this page, we will discuss region-level user types and how you can assign advanced region-level permissions to your users.
Users with advanced region-level permissions have powers that apply to individual regions within your world. These users can assist with setting up your individual regions and moderating your events, but cannot log in to your Dashboard in order to manage users, change default regions, approve content submitted to Curator, or change your world-level settings unless you have also assigned them advanced world-level user permissions.
It may be helpful to think of advanced region-level permissions as those you can assign and manage through the Region Information window.
In brief, the current region-level user types are:
Region Owners have absolute control over the region and its settings.
Owners can:
Access the region moderator controls.
Access the Region Editor.
Access the Region Information window and edit the region settings.
Manage the region member list and deal with disruptive users.
Region Administrators can perform many of the same tasks as Region Owners. They cannot appoint additional Administrators.
Administrators can:
Access the region moderator controls.
Access the Region Editor.
Access the Region Information window and edit most region settings.
Manage the region member list and deal with disruptive users.
Assign and manage advanced region-level permissions below the Administrator level.
Region Moderators have access to the moderator controls and certain region settings. They cannot appoint additional Moderators.
Moderators can:
Access the region moderator controls.
Access region member list in order to mute and block abusive users.
Assign and manage advanced region-level permissions below the Moderator level.
Region Developers have access to the Region Editor, and can decorate and modify the region to which they are assigned. They do not occupy a Developer seat, and cannot upload content to your world.
Developers can:
Access the Region Editor.
Region Members have no special privileges, but will be permitted to enter the region should Contact Only or Approved Only access be enabled.
If an unassigned user enters your region, they will appear in the member list as a Guest. Guests have no special privileges, and will not be permitted to enter the region if access is controlled.
Designating a user as a VIP gives them no special powers. Currently, this role is only useful for Lua script functionality and presenter seats.
Reminder: Only World Owners and World Administrators can manage and delete regions through the Dashboard.
To assign advanced region-level permissions to your users, please follow the steps below. For more information about adding users to your world, please visit this page.
Click on the Region Information button located above your mini map. This will open the Region Information window.
2. Click on the Members tab, and then the Add Members button. This will open the "Add new members" dialog box.
3. Use the search field to search for the user's name. Once you find it, click the Add button.
4. Once the user is added to the region members list, check the box next to their name and then click on the Set Role drop-down menu. From this menu, select the permissions level you'd like to assign the user.
To revoke advanced region-level permissions, simply follow Step 4 above, and select either the Member or Guest role. If you prefer, you can also remove the user from the members list entirely.
Alternatively, by enabling the "Groups Only" region access option, you can assign control over a region to one or more groups. When a region is set to "Groups Only," then the group member lists will override the region's existing members list, including any region members with advanced permissions.
This means that only Group Administrators, Group Moderators, Group Developers, etc. will be able to exercise their powers over the region as a whole. Additionally, only group members will be permitted to visit the region. Any users in the region member list will be ignored.
To disable group control over the region, simply choose a different region access option. Doing so will restore access and advanced permissions to any users in the region members list.
To remove a user from the region members list entirely, follow these steps.
Click on the Region Information button located above your mini map. This will open the Region Information window.
Click on the Members tab, and use the search field to search for the user's name.
Once you locate the user you want to remove, click the Edit button located to the right of their name. In the action menu that appears, click Delete.
For more information about muting and banning users, please see our region settings documentation.
Breakroom makes it simple to sell or distribute tickets to your event through Eventbrite. Here's how to find the information you'll need to integrate your Breakroom and Eventbrite accounts.
With Eventbrite integration, you can sell or distribute tickets to a virtual event and trust the backend logistics to us. Breakroom will automatically create a user account for anyone who purchases a ticket, using their ticket number as the password. If an account already exists under a user's email address, Breakroom will reactivate that account and reset the password to the ticketholder's current ticket number.
In order to integrate Breakroom and Eventbrite, you will need an active Eventbrite account. As a first step, log in to your Eventbrite account and create the event you plan to host in Breakroom. You can then follow the instructions outlined below to integrate your event with Breakroom's systems.
Once you've created your event on Eventbrite, you will need to locate the API key associated with that event and enter it into the Breakroom Dashboard. To get started, navigate over to your Eventbrite account settings page.
On the left side of your account settings page, you will see a drop-down menu called Developer Links. Expand it, and click on the tab that says API Keys. Then click on the button that says Create API Key.
Fill out the required information, and click the Create Key button.
Your API key should be created automatically. Click the > arrow above the application name (in this case, Breakroom) to expand the key information menu. Highlight and copy the private token key.
From here, you will need to enter the private token key into your Dashboard. Follow the instructions below to do so.
Click on the Integration tab on your Dashboard.
Under the Select an integration to configure heading, click on the Eventbrite button.
Paste your Eventbrite private token API key into the field.
Click the Create payload URL button.
Under the Payload URL heading, a special URL will be generated for you.
Highlight and copy the payload URL.
Return to the Eventbrite page to complete setup.
After you receive your payload URL, click on the Webhooks tab under Developer Links on your Eventbrite account settings page. Then click the button that says Add Webhook.
From here, you will need to enter the payload URL into Eventbrite. Follow the instructions below to do so.
Paste the payload URL into the top field.
Using the drop-down Event menu, select either a specific event or All Events, if you want to link more than one event to a single ticket purchase.
Check the box beside order.placed.
Click the button that says Add Webhook.
Once all of these steps are completed, you are ready to go.
When users purchase a virtual event ticket through Eventbrite, they will not receive a confirmation email from Breakroom. Therefore, we strongly encourage event organizers to use their Eventbrite event page, email, or other relevant tools to provide ticketholders with the information they will need to log in for the event.
Key points to communicate to ticketholders include:
Breakroom will automatically create a user account for anyone who purchases a virtual event ticket through Eventbrite. Their login will be the e-mail they provided to Eventbrite, and their password will be their ticket number.
If a Breakroom account already exists under a user's email address, Breakroom will reactivate that account and reset the password to the ticketholder's current ticket number.
Users will need to download the custom Breakroom desktop app or sign in through World Stream. Links to download the app or access your dedicated World Stream can be found on the Your Apps tab on the Dashboard.
By assigning special permissions to your team members, you can take collaboration and customization to a whole new level. Learn how to appoint Administrators, Moderators, and more.
There are two categories of special user permissions that you can assign to teammates, event coordinators, or end users—world-level permissions, and region-level permissions. It is important to note that these two categories are distinct, with their own separate spheres of influence and control. On this page, we will discuss world-level user types and how you can assign advanced world-level permissions to your users.
Users with advanced world-level permissions have broad powers that apply to the entirety of your Breakroom world, but not necessarily powers that apply to individual regions within that world. Users with advanced world-level permissions generally have rights and powers that allow them to help you manage your world, as well as the ability to upload new content.
It may be helpful to think of advanced world-level permissions as those you can assign and manage through the Dashboard.
In brief, the current world-level user types are:
Owners are responsible for managing billing details for their account and can review their past invoices via the Dashboard.
In addition, Owners can:
Modify or overwrite any content uploaded by other users.
Administrators can perform many of the same tasks as Owners, except they will not have access to billing information. They also cannot appoint additional Administrators.
Administrators can:
Access the Dashboard.
Modify or overwrite any content uploaded by other users.
Moderators can:
Access region settings in order to mute and block abusive users.
Developers can create and upload content to your world, as well as approve content uploaded by other users. They can also edit existing regions using the in-world Region Editor.
Developers can:
Modify or overwrite any content uploaded by other users.
Guest accounts are created when:
User accounts are automatically generated by Eventbrite, or any automated registration process you may choose to use.
Navigate to your Dashboard.
Click on the Manage Users tab.
To the right of each listed user, you will see a pencil icon. Click the pencil icon beside the user whose permissions you would like to edit.
3. An Edit User pop-up will appear. Click on the permissions level you would like the user to have. 4. Click on the Update button in the bottom right corner to save your changes.
Purchase additional seats, , and minutes.
, , make use of .
Edit all hosted on the world.
Access all .
and approve their own content.
and content uploaded by other users.
Appoint Administrators and change user types through the or .
Purchase additional seats, , and minutes.
, , make use of .
Edit all hosted on the world.
Access all .
and approve their own content.
and content uploaded by other users.
Appoint fellow Administrators and change user types through the .
Moderators have universal access to the moderator controls, so they can moderate events in any region. They do not have access to the Dashboard, and they cannot change or edit any regions unless they own that region or have been given .
Edit all hosted on the world.
Access all .
and approve their own content.
and content uploaded by other users.
List uploaded items for sale on the .
Access all .
Access the .
After you have granted a user Developer permissions, they will need to and accept the Terms and Conditions before they can .
Members occupy a seat and don't have any special privileges. You may choose to assign Members .
You , and do not specify another user type in the Type field.
While creating user accounts by uploading a CSV, you attempt to import more users than you have available . In this case, the extra user accounts will be created as Guests.
When Guest accounts log in for the first time, their account will be updated to Active. Member-type accounts and higher are always given login priority over Guest accounts.
To assign advanced world-level permissions to individual users, please follow the steps below. For more information about adding users to your world, please visit .
