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

# Connecting 8x8 to Neo

> Create an API key or turn on SCIM in a client's 8x8 Admin Console and save it in Neo

You connect 8x8 once for each client that uses it, with an 8x8 API key, the SCIM URL and token, or both, from the client's 8x8 account and [8x8 Admin Console](https://admin.8x8.com).

## 1. Get the values from 8x8

> [tab] API key
>
> **1. Ask 8x8 for Administration API access**
>
> 8x8 runs its Administration API (users, ring groups, sites, addresses, numbers) as a beta, and gives its keys to the accounts in that beta. Ask your 8x8 account manager to add the client's account, with these API products on its key:
>
> | API product | What it lets Neo do |
> | - | - |
> | **UC & CC User Admin** | Users: create, change, deactivate |
> | **UC Ring Group Admin** | Ring groups and their members |
> | **UC Site Admin** | Sites and addresses |
> | **UC & CC Number Admin** | Phone numbers |
> | **UC & CC Admin Operations** | Follow each change to completion; needed with any of the four above |
> | **Contact Management** and **Contact Search** | The company directory's shared contacts |
> | **Audit Records** | The Admin Console audit log |
>
> Until the account has that access, connect with SCIM to create and deactivate users.
>
> **2. Or make a key in Admin Console**
>
> The contact and audit products need no beta. An administrator whose role has the **Application Credentials** permission (the Company Admin role has it) opens **API Keys** in 8x8 Admin Console, clicks **Create App**, names it `Neo`, adds **Contact Management**, **Contact Search** and **Audit Records**, and copies the app's **Key**. Neo saves one key per client, so use the key that holds every product you want Neo to use.

> [tab] SCIM
>
> **1. Turn on SCIM**
>
> In 8x8 Admin Console, open **Identity and Security**, turn on **User Provisioning Integration (SCIM)**, choose **Other SCIM Provider**, and click **Save**.
>
> **2. Copy the URL and token**
>
> Copy the **8x8 URL** (it looks like `https://platform.8x8.com/udi/customers/<customer id>/scim/v2`) and the **8x8 API Token**.
>
> > [!WARNING]
> >
> > If the client already provisions 8x8 users from Microsoft Entra ID or another identity provider, 8x8 accepts SCIM changes from that provider only. Neo can still read users over SCIM; make the changes in the identity provider, or connect Neo with an API key instead.

## 2. Add the values in Neo

**1. Open Integrations**

In the Neo Dashboard, open [**Integrations** → **8x8**](https://dashboard.neoagent.io/integrations?open=eight_by_eight), under Phone & VoIP.

**2. Pick the client**

In **Customer**, choose the client this 8x8 account belongs to. The client must be on your **Companies** tab. For a second client, click **Add customer**.

**3. Save**

Paste the API key, the SCIM URL and token, or all three, and click **Save settings**. Neo checks each with 8x8 before saving: a key or token 8x8 refuses is rejected straight away, and so is a key that can read neither users nor contacts.

> [!WARNING]
>
> If someone deletes the app or regenerates the SCIM token in 8x8 Admin Console, save the new values here. Neo loses access to that client's 8x8 account until you do.

## 3. Turn 8x8 on per agent

**1. Open the agent's tools**

Open the agent in the Neo Dashboard, go to its **Tools & Settings** tab and click **Phone & VoIP**, or ask your Neo Support Agent to add 8x8 to it.

**2. Pick a preset**

Expand the **8x8** block and pick one of its **Presets**, or set each permission group by hand.

| Preset | What it does |
| - | - |
| **Read Only** | Reads users, ring groups, sites, numbers, contacts and the audit log; changes nothing |
| **Helpdesk** | Creates, changes and deactivates users and changes ring groups, asking a technician before each change |
| **IT Admin** | Every change on its own, except site and address changes, which ask a technician |
| **Full Automation** | Every supported call without approval, except deleting a site |

Deleting a site always asks a technician, whatever the preset.

An onboarding or offboarding agent needs **Users** and **Ring Groups**, and **Sites, Addresses & Numbers** as Read Only to pick the new starter's site and a free number.

## How updates work

8x8 replaces a whole record on every update. Neo reads the record first and keeps every field the agent does not change, so an update to a user's department leaves their licence, extension and devices as they were. 8x8 never returns a ring group's voicemail PIN, so the agent changes ring group members on their own and leaves other ring group settings, and every PIN, to a technician in 8x8 Admin Console.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.