Skip to content

Setup & Projects

Before you can start recording sessions, you need to create a project in the Nveal Dashboard.

Creating a Project

  1. Log in to your Nveal account.
  2. Navigate to the Dashboard home.
  3. Click on New Project.
  4. Enter your project name and the domain(s) where the SDK will be deployed.
  5. Click Create.

API Keys

Once your project is created, you will be presented with an API Key.

Important

The API Key is required for the SDK to authenticate with the Nveal servers. You can copy it from the Project Settings page at any time.

Rotating Keys

If your API key is leaked, you should rotate it: 1. Go to Project Settings. 2. Click Rotate API Key. 3. Update the apiKey in your SDK initialization code immediately.

Custom Domains

You can configure a custom API base URL if you are proxying Nveal requests through your own backend (for example, to bypass ad-blockers or for better privacy control). Simply provide the root URL of your proxy endpoint.

nveal.init({
  apiKey: 'your-api-key',
  apiBaseUrl: 'https://api.yourdomain.com', // The root URL of your proxy
});