Help centerIntegrations

For: Admins

Create an API key

Create a manage key for the Admin Panel's API or a hub key for the portal's API, limit it to your IP addresses, and copy it once.

Takes about 5 min Updated Nov 6, 2026

In this article8 sections

An API keyKey A secret token, created under Integration, that lets your own software use the hub's API. lets your own software, such as a case management system, work with your hub. A manage key uses the Admin Panel's API, for cases and people; a hub key uses the portal's API, for the work inside cases. Understand what the API can do compares them.

  1. Open Keys

    Go to Integration › Keys and choose NEW.

  2. Name it

    Under Description, say what will use it, such as Case sync.

  3. Limit where it's used

    Under Source CIDR, type the public IPv4 address your system calls from, such as 203.0.113.10, or a range, such as 203.0.113.0/24. Calls from anywhere else are refused. The hub sees only IPv4 addresses, so an IPv6 address is refused.

    If you don't know the address yet, leave the box empty, which allows any address. After your system's first call, Last Used IP shows it; see Restrict or revoke an API key.

  4. Choose its type

    Under Domain, choose manage for the Admin Panel's API or hub for the portal's API. It can't be changed later.

  5. Switch it on and add it

    Active starts on. Leave it on: an inactive key is refused on every call. Choose Add Key. "Key added" shows.

  6. Copy the key

    The Secret Key window shows the key only this once. Choose the copy button, Copy to clipboard, and store the key where your developer can reach it safely, such as a password manager. Then choose Done.

What happens next

The key works at once and doesn't expire. Your developer sends it with each call; see Authenticate API requests with a key. It acts as your hub's Virtual AssistantVirtual Assistant An automated team member that posts welcome messages, check-ins and stage posts for the firm; its posts carry a Virtual Assistant badge., so what it posts shows as the Virtual Assistant's.

Last Used and Last Used IP show the date and address of its latest call. To switch it off or delete it, see Restrict or revoke an API key.

If something goes wrong

  • "Key limit has been reached." Your hub can have two keys of each type. Delete one of that type you no longer use.
  • Source CIDR says "Address block is invalid. Example: 203.0.113.10 or 203.0.113.0/24." Check the address: four numbers from 0 to 255 with dots between, and, for a range, a slash and a number up to 32.
  • Source CIDR says "Use an IPv4 address or range, such as 203.0.113.10. The API is reached over IPv4 only." You typed an IPv6 address. Use your system's IPv4 address instead.
  • You lost the key. It can't be shown again. Create a new one, move your system to it, then delete the old one. If your hub already has two of that type, delete the old one first; your system can't call the hub until it has the new key.

Related articles

Authenticate API requests with a keySend your key as a bearer token to the Admin Panel's API for a manage key or the portal's API for a hub key, and limit it to your IP addresses.IntegrationsRestrict or revoke an API keyLimit a key to certain IP addresses, switch it off, or delete it, and see when it was last used.Integrations · 2 minUnderstand what the API can doLearn what a manage key and a hub key can each reach, why every key acts as the Virtual Assistant, and where the full technical listing is.Integrations