Skip to content
Back to Guides

Onboarding with workspace keys

·

OpenTelemetry

Create your workspace and first App in the dashboard. Each workspace receives a Default public key, and the first App created through onboarding becomes its default App. The onboarding flow and App overview show the workspace public key as Public key. The older App key is marked deprecated and remains accepted.

Configure credentials

Copy the workspace key from onboarding or Settings → Developer → Public keys. Use one workspace key across the workspace’s Apps.

VariablePurpose
INTERFERE_PUBLIC_KEYPublic workspace or App key for Next.js.
VITE_INTERFERE_PUBLIC_KEYPublic workspace or App key for Vite.
INTERFERE_API_KEYServer-side secret used by SDK builds to publish releases and upload source maps.

New onboarding secrets belong to the workspace. Build publishing requires Publish releases (release:write); the public key and service identity select the target App. Keep secrets out of browser bundles and source control. Existing App-scoped secrets remain supported.

Give each App a stable service name

Set serviceName: "storefront" in Next.js withInterfere() or Vite interfere(), then use that same value in browser init() and server/edge register() when used. In the dashboard, name the App when creating it or edit its title on the App page. Use Services to inspect the association between the service name and App.

An SDK sends this name in x-interfere-service. That header takes precedence over OTLP service.name and service.namespace; requests without a usable identity use the default App. A new named service can create an App on first sight, within the limits of 20 new Apps per request and 50 auto-created Apps per workspace.

In Settings → Developer → Public keys, set Default app and choose whether to enable Create apps from telemetry (auto_create_apps). An explicit_only App is excluded from implicit name matching and default fallback. See Workspace keys for the full routing and migration rules.

Verify the installation

Run a build with the public key, the build secret and the intended service name configured. Connect the App’s repository and deployment integration for release publishing. Send telemetry and check that it appears under the expected App; check the release there too. A successful build alone does not prove that the credentials or routing are correct, because API failures can be logged without failing the build.

For an existing installation, preserve the service name before replacing an App key. For infrastructure-managed credentials, use the Terraform provider guide.