Skip to main content
You connect MSPortal once at the MSP level. Neo needs an API key and the region your MSPortal is hosted in.

​
1. Create the API key

1

Open API Access

In MSPortal, open Settings > Integrations > API Access.
2

Create a key with the scopes your agents need

Create a key and give it the read scopes of the areas your agents use. The churn scan needs companies.read, customer_success.read, surveys.read and analytics.read. Add a .write scope only for an area where an agent should change something, such as customer_success.write to log Traffic Light reviews.
3

Link it to a user who can see those areas

MSPortal checks both the key’s scopes and the permissions of the user the key is linked to, so link it to a user whose role can read Client Health (read_customer_success) and the other areas.
4

Copy the key

Copy the key and keep it for the next step.

​
2. Add the key in Neo

1

Open Integrations

In the Neo Dashboard, open Integrations and find the MSPortal card, under Customer Success.
2

Save the key

Paste the API Key, pick the Region (United States if your MSPortal opens at app.msportal.ai, Europe if it opens at eu.msportal.ai) and click Save settings. Neo reads one company from MSPortal before saving, so a wrong key, a key without companies.read, or the wrong region is rejected straight away.

​
3. Turn MSPortal on per agent

Open the agent, go to its Tools & Settings tab, click Customer Success, and expand the MSPortal block. Pick a preset, or set each area yourself: Whatever the preset, deleting a company, adding a portal contact, creating or inviting a user, changing a user’s status, any change to a role and any change to an automation rule always ask a technician.

​
Use it on tickets and in scans

A scheduled agent with no ticket, such as the monthly churn scan, can read every client. On a ticket, an agent sends only calls that name the MSPortal company mapped to the ticket’s company, for example to explain why that client’s health fell or to add its health to a business review. Map your companies on the Organization Mapping tab first. See MSPortal API for the permission groups.