Skip to Content
Getting StartedQuick Start

Quick Start

Get the Maestrio feedback widget running in your app in four steps.

1. Import and initialize

import { createMaestrio } from "@maestrio/sdk";
 
const maestrio = createMaestrio({
  apiKey: "your-api-key",
  baseUrl: "https://app.maestrio.ai",
  projectId: "your-project-id",
});

You’ll find your API key in Settings → API and your Project ID in the project settings page of the dashboard.

2. Identify the user

Before showing the widget, identify the current user. This associates feedback with a specific user in your dashboard.

maestrio.identify("user-123", {
  name: "Jane Doe",
  email: "[email protected]",
});

The first argument is a unique user ID from your system. The second is an optional object with user properties.

3. Show the widget

maestrio.show();

A floating feedback button appears on the page. Users can click it to report bugs or suggest features.

4. Clean up (optional)

If you need to remove the widget — for example, on sign-out or page navigation in a SPA — call destroy():

maestrio.destroy();

Full example

import { createMaestrio } from "@maestrio/sdk";
 
const maestrio = createMaestrio({
  apiKey: "mst_live_abc123",
  baseUrl: "https://app.maestrio.ai",
  projectId: "proj_xyz",
});
 
// After your user logs in
maestrio.identify("user-123", {
  name: "Jane Doe",
  email: "[email protected]",
});
 
maestrio.show();

Auto-show on identify

You can skip the explicit show() call by passing autoShow: true in the system properties:

maestrio.identify(
  "user-123",
  { name: "Jane Doe", email: "[email protected]" },
  { autoShow: true }
);

What happens next

When a user submits feedback through the widget:

  1. The request is sent to your Maestrio project
  2. It appears in your Kanban board with status Received
  3. Maestrio’s AI agents triage, score, and optionally implement the change
  4. You review and merge the generated pull request

Next steps

InstallationcreateMaestrio()