API keys
API & Integrations requires an Enterprise plan. Only Workspace Admins can generate and manage API keys.
Generate API keys to run Revsnap regressions from your CI/CD pipelines.
Why use API keys?
Catch pricing and configuration drift on every pull request. Generate secure API keys, trigger snapshot runs from GitHub Actions, GitLab CI, or Jenkins, and fail the build before a regression reaches production.
Generate a key
- Go to API & Integrations in the sidebar (
/api-keys). - Click Generate API key.
- Give the key a name, choose an expiration, optionally scope it to a specific environment (connected org), and choose its permissions.
- Copy the key immediately: it is shown only once.
There is no way to re-display or regenerate a key. If you lose it, generate a new one and revoke the old one.
Environment scope
Bind a key to a specific environment so production keys cannot accidentally hit sandboxes (and vice versa). A scoped key is refused with an error if a pipeline points it at any other environment. Scoped keys appear in audit logs with the correct environment context.
Leaving the scope as All Environments lets the key reach every connected org in your workspace: convenient, but prefer a pinned key for anything touching production.
Permissions
Each key is issued with one of two permission sets:
| Permission | Can do | Use it for |
|---|---|---|
| Start runs and read results | Trigger regressions and poll results | CI pipelines that run tests on a PR |
| Read results only | Poll run and batch status | Dashboards, reporting jobs, status badges |
A read-only key cannot start a run: the request is refused with a clear error naming the missing permission. Prefer read-only for anything that only reports on runs someone else triggered.
Keys generated before this option existed have both permissions.
How Salesforce credentials are used
Your pipeline never sends Salesforce credentials to Revsnap. The API key authenticates the request to Revsnap; Revsnap then uses the OAuth connection you established for that environment in the web app to talk to Salesforce. If that org connection expires or is revoked, runs will start and then fail with a connection error: reconnect the org from the Environments page.
Revoking keys
Workspace Admins can revoke keys from the API & Integrations page. Revoked keys stop working immediately. Rotate keys periodically as part of your security hygiene: generate the replacement, update your pipeline secret, then revoke the old key.
An API key acts on behalf of the admin who generated it. If that person is deactivated or removed from the workspace, every key they generated stops working, even if the key was never revoked and has not expired.
Before offboarding an admin, check the Last used column on the API & Integrations page for keys that are still active in a pipeline, and have another admin issue replacements first.