Settings

What this is

The Settings section contains your personal preferences and account credentials. It is split into three pages: Profile (your display name and time zone), Notifications (email alerts for run lifecycle events), and API keys (personal tokens for scripts and CI pipelines).

Settings are personal — they apply to your user account across all workspaces and accounts you belong to.

Where to find it

The Settings group is in the bottom of the left sidebar (account nav). It expands to show three sub-items: Profile, Notifications, and API keys. The base route is /settings/profile.

---

Profile

The Profile page stores your display name (given and family name) and your preferred time zone.

Settings Profile: identity section with inline-editable name fields and time zone selector.

How to update your profile

1. Navigate to Settings → Profile in the left sidebar (or go to /settings/profile).
2. To edit Given name or Family name, click the pencil icon next to the field. Type the new value and press Enter or click Save. The change saves immediately via PATCH /v1/me/profile.
3. To change your Time zone, open the dropdown and select an IANA timezone (e.g., America/New_York). The selector saves as soon as you pick a value — no separate save button.
4. A “Saved — Profile updated.” toast confirms the change.

Email is read-only

Your email address is sourced from your identity provider (IdP) token and cannot be changed in the console. If you need to update your email, do so through your IdP (e.g., Google Workspace, Okta).

Time zone affects the console only

The time zone you set controls how dates and times are displayed across the console (run start times, key expiry, secret last-updated). All timestamps are stored in UTC on the API side; the conversion is purely a display preference.

---

Notifications

The Notifications page controls which run lifecycle events send an email to your account address.

There are three toggles:

Toggle	When it sends email
Run completed	When a test run finishes successfully
Run failed	When a test run ends in a failed state
Run cancelled	When a test run is cancelled or stopped before completion

Settings Notifications: email preferences for run lifecycle events. Each toggle updates immediately on change.

How to configure email notifications

1. Navigate to Settings → Notifications in the left sidebar (or go to /settings/notifications).
2. Check or uncheck any toggle. The preference saves automatically — a “Saved — Email notification preference updated.” toast confirms each change.
3. To stop all run emails, uncheck all three toggles.

Workspace webhooks

These toggles control email notifications to your personal account only. Workspace-level webhook destinations (for Slack, PagerDuty, etc.) are managed separately from the workspace settings, not here.

---

API keys

The API keys page lets you create, inspect, and revoke personal API tokens for use in CI/CD pipelines, scripts, and integrations.

Each key has a name, an optional description, an expiry date, a status (active or revoked), and usage metadata (last used time and source IP). The token value is shown only once immediately after creation — after you dismiss the copy panel, the plaintext is never accessible again. The console stores only masked metadata (prefix…last4).

Settings API keys: key list with masked token identifiers (prefix…last4), expiry, and status badges. No plaintext token is stored or shown.

How to create an API key

1. Navigate to Settings → API keys in the left sidebar (or go to /settings/api-keys).
2. Click Create API key in the page header. A dialog opens.
3. Enter a Name for the key (required, e.g., CI deploy token).
4. Optionally enter a Description to document the key’s purpose.
5. Choose an Expiry from the preset options: 1 month, 1 year (default), or 10 years.
6. Click Create key. The dialog closes and a Copy your new API key panel appears at the top of the page.
7. Copy the token immediately using the Copy token button. Click Hide token when you are done.

Copy-once — token cannot be recovered

The plaintext API token is displayed exactly once in the “Copy your new API key” panel. After you click Hide token or navigate away, the token cannot be retrieved. Store it in a secrets manager (e.g., GitHub Actions secrets, HashiCorp Vault) before dismissing the panel.

How to revoke an API key

1. On the Settings → API keys page, find the key in the list.
2. Click Revoke next to the active key. A confirmation dialog appears with the key name.
3. Click Revoke key. The key status changes to revoked immediately. Any integration using that token starts failing at once — there is no grace period.
4. After revocation, create a replacement key if needed and update the affected integrations with the new token.

Rotate before expiry

API keys expire on the date you chose at creation. Plan ahead: create a replacement key before the old one expires, update your integrations, then revoke the old key. The key list shows expiry dates for all active keys.

How to use an API key

Pass the token as a Bearer token in the Authorization header of any MaxoPerf API request:

Authorization: Bearer <your-token>

The key is scoped to your user account and carries the same permissions as your account across any workspace or project you have access to.

---

Tips & gotchas

• Profile changes are immediate. Name and time zone edits take effect as soon as the inline save succeeds. No page reload is needed.
• Notification toggles are per-user, not per-test. Enabling “Run failed” sends an email for every failed run in any workspace you belong to. If you belong to multiple high-traffic accounts, consider enabling only the events most relevant to you.
• API keys are personal, not shared. Each key is tied to your user account. Do not share your API key with team members — have each person create their own key.
• Revocation is instant. There is no cool-down period after revoking a key. Coordinate key rotation with your team before revoking a key used in a shared pipeline.
• Key expiry vs revocation. Expired keys stop working automatically on their expiry date. Revoked keys stop working immediately regardless of their expiry date. Both statuses appear in the key list.

---

Related docs

• Manage test secrets — workspace secrets for injecting credentials into test runs (separate from personal API keys).
• Secrets — console guide for the workspace secrets vault.
• Billing — plan, quota, and payment management.
• Members and invites — adding and managing team members on your account.
• Run tests from CI — how to use an API key to trigger runs from a CI pipeline.