Team settings
This reference describes your team settings on the Instruqt platform, which allow you to manage and customize the platform.

Set team settings

You can set the following team settings:
  • Invites
  • Insights
  • Manage team
  • API keys
  • Track limits
  • Webhooks
  • Hot Start
  • Branding
Start with opening your Content page to set the team settings:
🌐 Web UI
  1. 1.
    Open your browser and go to play.instruqt.com. ↳ Instruqt shows your Content page.
Now let's look at each setting.

Invites

See the topic Create track invite for details on this setting.

Insights

Maybe not a setting in the strict sense, but Insights give you insight into how often your tracks are started and completed. For example, to show track plays for a specific period:
🌐 Web UI
  1. 1.
    Click Insights. ↳ Instruqt shows the Insights page.
  2. 2.
    In the Filter by date fields, enter the start and end date of the period you want to query.
  3. 3.
    Click Apply. ↳ Instruqt shows the plays for the selected period.
  4. 4.
    Apply values to the Filter track developers list and the Filter tracks list if you want to change or narrow your selection.

Manage team

Manage team allows you to add members to your team or change the role of existing members. To add a new member:
🌐 Web UI
  1. 1.
    Click Manage team. ↳ Instruqt shows the Manage team members page.
  2. 2.
    In the Invite more members field, enter the member's email address you want to add. ↳ Notice that the Send invite shows up after you enter the email address.
  3. 3.
    In the Role list, select the role you want to assign.
  4. 4.
    Click Send invite.

API keys

The API keys setting holds an API key (or API token) that external systems can use to access tracks. For example, an CI/CD system that automatically tests tracks. To regenerate an API key and copy it to the clipboard:
🌐 Web UI
  1. 1.
    Click Team settings > API keys. ↳ Instruqt shows the Manage API keys page.
  2. 2.
    Click Regenerate API Key. ↳ The API Key field shows the new API key.
  3. 3.
    Click Copy to clipboard.
Now you can move over to your external system and apply the copied API key.

Track limits

Track limits allow you to set a play limit per track:
🌐 Web UI
  1. 1.
    Click Team settings > Track limits. ↳ Instruqt shows the Manage track limits page with all your tracks.
  2. 2.
    In the Play limit field of the track you want to limit, enter the number of plays you want to allow. ↳ Notice that the corresponding Save button turns red after you enter a number.
  3. 3.
    Click Save.

Webhooks

See the topic Webhooks for details on this setting.

Hot Start

See the topic Hotstart a sandbox for details on this setting.

Branding

You can customize the look of Instruqt to suit your brand. For example, change the Team page title and set the Background color:
🌐 Web UI
  1. 1.
    Hoover over the branding bar and click Edit Branding. ↳ Instruqt shows a sidebar at the right with Branding settings.
  2. 2.
    In the Title field, enter a new title. ↳ Notice that Instruqt changes the title as you type.
  3. 3.
    Click one of the colors from the Background color section. ↳ Notice that Instruqt immediately changes the background color.
  4. 4.
    Apply values to the other settings to suit your brand.