Overview
API Keys manages deal-scoped credentials for the selected client's SalesHive Platform API access. An eligible client can keep up to 10 active named keys, use a separate key for each integration, review usage, replace or revoke one key without disturbing the others, and retain revoked credentials in the audit history. API authentication works only while the client is active and in the Onboarding or Active pipeline. Full key values are shown only once when they are created or replaced.
How to use this page
Check the selected client and access state
Confirm the client in the Client Switcher. The header shows whether API access is Enabled or Suspended, the client's effective pipeline, active-key count, authenticated request total, most recent use, and revoked-key count. Copy the Base URL, https://app.saleshive.com/api/public/v1, when an integration asks for the API endpoint.
Save the default key or add an integration key
Opening API Keys for an eligible client with no active credentials creates a Default API Key automatically and displays its full value once. Copy and store that value before leaving or refreshing. To add another credential, enter a descriptive name such as Reporting Integration and select Add API key. Use a separate named key for each connection. A client can have up to 10 active keys.
Review usage or rename a key
Each Active Keys row shows the name, masked value, created time, last use, and authenticated request count. The Default badge identifies the original primary credential. Select Rename to edit a label, then Save or Cancel. Renaming changes only the label, not the secret or integration access.
Replace one connected key
Select Replace on the exact integration key that needs a new secret. Review the confirmation, then select Replace key. The old key stops working immediately, the replacement keeps the same name and Default designation when applicable, and its full value appears once. Copy it and update the connected system before leaving the page.
Revoke keys and understand suspension
Select Revoke and confirm when a key should stop authenticating without a replacement. The credential moves to Key History and cannot be used again. If the client leaves the Onboarding or Active pipeline, or is archived, API authentication is suspended and Add API key and Replace are unavailable. Existing unrevoked keys stay in the audit trail and work again if the client returns to an eligible pipeline.
What the buttons do
- View API docs
- Opens the public SalesHive Platform API documentation in a new tab.
- Copy (base URL)
- Copies https://app.saleshive.com/api/public/v1 for use as the integration's API endpoint.
- Copy API key
- Copies the full newly created or replacement secret while it is shown. SalesHive cannot display that full value again.
- Add API key
- Creates another named credential for the selected eligible client, up to 10 active keys.
- Rename
- Opens one key's name for editing without changing its secret.
- Save
- Saves the edited key name.
- Cancel
- Closes a rename editor or confirmation without applying the action.
- Replace
- Opens a confirmation for replacing the selected key with a new one-time secret.
- Replace key
- Confirms replacement. The selected old key stops working immediately and moves to Key History.
- Revoke
- Asks for confirmation, then disables the selected key without creating a replacement.