Home / Basics / Dashboard

Using the Dashboard

Overview

This guide provides an overview of using the dashboard as a developer. For an overview of using the dashboard as a customer support or non-technical user, see the Using the dashboard support guide.

The Highnote dashboard is a no-code user interface built on top of the Highnote API. The Developers section of the dashboard contains several developer-related controls. This guide provides an overview of using the Highnote dashboard as a developer.

To access the dashboard, sign up for a new account or log in.

dashboard.png

Test and live environments

The Highnote dashboard lets you switch between test and live environments using the environment drop-down. For a general overview of the test and live environments, see the Using the Highnote dashboard support guide.

CleanShot 2022-11-30 at 14.06.12@2x.png

API keys

You can create and manage API keys from the Highnote dashboard. You must have a valid API key to interact with the Highnote API.

We recommend rotating API keys to mitigate risk and misuse of sensitive data. For more information, see Rotating API Keys.

Create API key

Use the following steps to create an API key:

  1. From the Highnote dashboard, click Developers.
  2. On the API Keys tab, click Create API Key.
  3. Provide an API Key Name and click Create API Key.
  4. Copy your API key and store it in a safe location. For security reasons, we can’t display the API key again.
  5. Once you’ve copied and stored your API key, click I’ve copied my key.

Revoke API key

Use the following steps to revoke an API key:

  1. From the Highnote dashboard, click Developers.
  2. On the API Keys tab, locate the API key you want to delete.
  3. Click Revoke API Key.

Notifications and events

The Highnote dashboard allows you to manage notifications, targets, and events. For more information on using the dashboard to manage notifications, see the following support guides:

Collaborative authorization

Using the Highnote dashboard, you can add collaborative authorization endpoints, which allow you to receive collaborative authorization requests.

For more information on using the dashboard to manage collaborative authorization endpoints, see the following support guide: Collaborative authorization.

Dashboard roles and permissions

The Highnote dashboard offers different user and permission levels:

  • Admin
  • Support

For an overview of dashboard roles and permissions, see Dashboard roles and permissions.

Provide Feedback

Was this content helpful?