Skip to content
English
More support
Contact us
  • There are no suggestions because the search field is empty.

How Do I Create an API Key for Leads Integrations?

Generate a secure API key to connect your Leads data to an external system, like a CRM.

Settings > System Integrations

System Integrations lets you connect Octiv to external systems - like a CRM - using secure, machine-to-machine API keys. An API key acts like a password that lets two systems talk to each other without a person needing to log in each time.

This first version supports API keys for Leads. Access to System Integrations is controlled by a specific permission and is off by default for everyone except the Owner. Before an Admin or Location admin can use System Integrations, an Owner must grant them access - see below. Octiv recommends granting this permission only to Owners, Admins, or Location admins, not Trainers.

Granting access to System Integrations

System Integrations won't appear in Settings for a staff member until this permission is turned on.

  1. Go to Staff.
  2. Click the menu icon next to the staff member's name and select View/Edit.
  3. Open the Access tab.
  4. Under Octiv Access, check System Integrations ("Ability to use oAuth Personal Access Tokens for machine-to-machine communications").
  5. Click Submit.

See Editing Staff Details for more on managing staff access.

Creating an API Key

  1. Go to Settings > System Integrations.
  2. In the API Keys card, click Create API Key.
  3. Enter a Key Name that identifies the system it will be used by (for example, "Landing Page Connector").
  4. Under Scopes, select leads:create to allow the key to create lead members.
  5. Click Generate Key.

Note: Copy your API key immediately and store it somewhere safe. For security reasons, the full key is only shown once and cannot be retrieved again after you close the "API Key Created" dialog.

On the API Key Created dialog, click Copy to copy the key, toggle I have copied my API key and stored it securely, then click Done.

Viewing your API keys

All keys created for your facility are listed on the System Integrations page, showing the key's Name, Scope, and the date it was Created. The key itself is never shown again in this list - only its name and scope.

Deleting an API Key

  1. On the System Integrations page, find the key in the list.
  2. Click the delete icon under Actions.
  3. Confirm by clicking Delete Key in the dialog.

Note: Deleting a key is immediate and cannot be undone. Any external system still using that key will lose access to the Octiv API right away.

You can create a new key at any time to replace a deleted one.

What this first release covers

This release covers creating, naming, viewing, and deleting Leads API keys. It does not yet include key expiration, key rotation, audit logs, or integration types beyond Leads - these may be added in future releases.