Organization & User Administration Administering User Onboarding

Setting up a new organization and bringing your team on board is the first step to success on the platform. This guide walks you through creating an organization, customizing your workspace, and inviting users to join so they can start collaborating immediately.

flowchart LR
    A["Create Organization"] --> B["Upload Logo"]
    B --> C["Complete Setup"]
    C --> D["Invite Users"]
    D --> E["User Accepts Invite"]

Setting up a new organization

Before users can join, you need to establish their workspace. The platform provides a streamlined workflow to get new organizations ready for action.

  1. 1

    Create the organization

    Start by creating the base organization profile. You will need to provide basic details like the organization's name and billing information.

  2. 2

    Customize the workspace

    Personalize the experience by uploading the organization's logo. This helps new users immediately recognize their workspace when they log in.

  3. 3

    Complete onboarding

    Once the details and branding are in place, mark the organization's onboarding as complete. This activates the workspace and unlocks the ability to invite team members.

Always upload a high-resolution logo. A familiar, branded workspace increases user trust and significantly improves the initial onboarding experience!

Inviting users to the platform

With the organization active, you can start building the team.

To invite a new user, navigate to the Users section of your organization dashboard and select Invite User. The system will send an email invitation containing a secure link.

The user acceptance flow

When you invite a user, they go through a simple acceptance process:

  1. The user receives an email notification.

  2. They log in to view their Pending Invitations.

  3. They click Accept on the invitation to officially join your organization.

Until a user accepts their invitation, they will not have access to the organization's resources.

Managing your team

As an administrator, keeping track of who has joined and who is actively using the platform is crucial.

You can view different segments of your user base at any time:

ViewDescription
All UsersA complete list of everyone associated with the organization, including pending invites.
Active UsersA filtered list showing only users who have accepted their invitations and are actively enabled.

Global Administration

If you are a system administrator managing multiple customers, you have access to a global overview. You can view a complete list of all organizations, dive into specific customer overviews, and even export your entire customer list as a CSV file for external reporting or auditing.

How do I see who hasn't accepted their invite?

You can compare your All Users list with your Active Users list. Users who appear in the complete list but not in the active list are typically those who still have pending invitations.

Can I export my user data?

Yes! System administrators can export the complete customer and organization list as a CSV file directly from the Admin dashboard.

What happens if an organization is deleted?

Deleting an organization is a permanent action. It removes the workspace and revokes access for all active users within that organization. Always ensure you have exported any necessary data before proceeding with a deletion.

Tracking onboarding progress

As users navigate through your documentation, you can monitor and manage their progress through onboarding wizards. The system allows you to:

  • Retrieve progress: View the current status of a user's wizard completion for specific documentation.

  • Update progress: Upsert new progress data as users complete required steps.

  • Reset progress: Delete existing progress records to allow a user to restart an onboarding wizard.

Managing user preferences

To further customize the onboarding experience, you can manage individual user preferences. Administrators can retrieve a complete list of user preferences, set specific preference values, or delete a preference to revert it to the system default.

Need to automate this process?

All onboarding actions, from creating organizations to inviting users, can be automated using our REST API. Check out the API Reference to learn more.