> ## Documentation Index
> Fetch the complete documentation index at: https://docs.callivox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Integration API keys

> Create a key that connects an embedded Callivox inbox to your workspace, and revoke it when it is no longer needed.

An integration key is a password-like string that lets another system connect to your Callivox
workspace. The usual reason to create one is to embed the Callivox inbox inside another product —
for example a Dynamics 365 screen — so your team can work in Callivox without leaving that system.

Go to **Settings → Integration**. The page is **Admin only**.

<Frame caption="Settings → Integration: generate a key, then manage the active ones below.">
  <img src="https://mintcdn.com/haconsultancy/8jQZZfLAZM_xjJe7/images/settings/api-keys.png?fit=max&auto=format&n=8jQZZfLAZM_xjJe7&q=85&s=080d3aa6d1e9a8a29d0f43bc41edeed4" alt="The Integration settings page showing the key generator and a list of active keys" width="2880" height="1800" data-path="images/settings/api-keys.png" />
</Frame>

## Creating a key

The card **Integration API keys** explains what it is for:

> Generate a key to connect an embedded host (e.g. the Dynamics 365 inbox) to this tenant. Paste the
> key into the host's Callivox configuration. The key is shown once — store it securely.

<Steps>
  <Step title="Name it">
    Enter a **Key name** describing where it will be used — for example *Dynamics 365*. One key per
    place makes it obvious later which one to revoke.
  </Step>

  <Step title="Generate">
    Click **Generate key**. You will see **"Integration key created"**.
  </Step>

  <Step title="Copy it now">
    A panel appears reading **"Copy your new key now — it won't be shown again."** Click **Copy** and
    paste the key straight into the other system's Callivox configuration.
  </Step>
</Steps>

<Warning>
  The key is displayed once. If you navigate away without copying it, there is no way to see it
  again — revoke it and generate a new one.
</Warning>

## Keeping a key safe

A key gives whoever holds it access to this workspace's data. Treat it like a password:

* Paste it directly into the system that needs it. Do not send it by email or chat, and do not put
  it in a shared document.
* Give each system its own key, so revoking one does not disconnect the others.
* Revoke a key as soon as the system that used it is retired, or if you think it has been seen by
  someone who should not have it.

There are no per-key permissions — a key is either active or revoked.

<Note>
  Creating new keys may depend on your plan. Keys you already have keep working either way.
</Note>

## Managing active keys

The **Active keys** card lists every key that is still live: its name, a short prefix so you can tell
them apart, and either `Created {date} · last used {date}` or `· never used`.

The `last used` date is the useful one. A key that has never been used points at a setup that was
never finished; a key that has not been used for months is probably safe to remove.

## Revoking a key

Click **Revoke** on the key's row. The confirmation reads `Any host currently using "{name}" will
immediately lose access to this tenant's data. This can't be undone.` Confirm with **Revoke key**;
you will see **"Key revoked"**.

<Warning>
  Revoking is instant and permanent. The embedded inbox using that key stops working straight away.
  If you need to rotate a key, generate the replacement and put it in place first, then revoke the
  old one.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Workspace and users" icon="users" href="/settings/workspace-and-users">
    Your workspace details and the people in it.
  </Card>

  <Card title="AI connections" icon="plug" href="/mcp/overview">
    Connecting an AI assistant to this workspace — a separate mechanism with its own permissions.
  </Card>
</CardGroup>
