Connecting INKY to Neo

You connect INKY once at the MSP level. One API key made at your top-level organization covers every client team beneath it.

1. Create the API key

INKY fixes a key’s permissions when it is created, and its default role leaves some out. Choose them now; to add one later you create a new key.

Open API Keys

Sign in to the INKY console as a super admin of your top-level organization (app.inkyphishfence.com, or app.eu.inkyphishfence.com in Europe) and open Settings > API Keys.

Choose the permissions

Create a customer-issued API key (INKY’s term), name it Neo, and give it the permissions for the jobs your agents do:

Job	Permissions
Read INKY’s analysis of a message	`messages.read`
Read reported mail	`reported_mail.read`
Confirm, reject, remediate or dismiss a report, and see the allow and block options on a reported message	`reported_mail.execute`
Read, add, change or remove allow-list rules	`allow_list.read`, `allow_list.create`, `allow_list.modify`, `allow_list.delete`; `allow_list.execute` for a rule that allows everything from a sender
Read, add, change or remove block-list rules	`block_list.read`, `block_list.create`, `block_list.modify`, `block_list.delete`
Manage VIPs	`vip_list.read`, `vip_list.create`, `vip_list.modify`, `vip_list.delete`
Manage console admins	`admins.read`, `admins.create`, `admins.modify`, `admins.delete`

Copy the key

Copy the key. INKY shows it only once.

Do not revoke or rotate the key in INKY after you connect it, and note its expiry date. Neo loses access until you save a new key here.

2. Add the key in Neo

Open Integrations

In the Neo Dashboard, open Integrations and find the INKY card, under Security.

Save the key

Choose the region you sign in to, paste the API key and click Save settings. Neo checks it against INKY before saving, so a wrong key or region is rejected straight away. A partner integration key is refused: create a customer-issued API key.

3. Turn INKY on per agent

Open the agent, go to the Integrations section, and pick an access profile for the INKY block, or set each area yourself:

Area	Access levels you can pick	Notes
Teams and Usage	Disabled, Read Only	Your organization nodes and client teams, protected domains and mailbox usage.
Messages and Statistics	Disabled, Read Only	INKY’s analysis record of each inbound message, and daily counts per team.
Reported Mail	Disabled, Read Only, Read / Write	Reported messages; confirming, rejecting, remediating and dismissing reports.
Allow List	Disabled, Read Only, Read / Write	Allow-list rules, and applying an option INKY offers on a reported message, which needs Block List too. An allow rule weakens protection.
Block List	Disabled, Read Only, Read / Write	Block-list rules.
VIPs	Disabled, Read Only, Read / Write	Each team’s VIP list.
Console Admins	Disabled, Read Only, Read / Write	INKY console roles on each team.
Organization-Wide Changes	Disabled, Read / Write	Any write to an organization node. INKY applies an allow rule, a block rule or an admin grant written there to every team beneath it.

Profile	What runs on its own	What asks a technician
Read Only	Every read	No write is allowed
Helpdesk	Every read, and reported-mail reviews and verdicts	Allow-list and block-list changes. VIP, admin and organization-wide changes are off
IT Admin	Every read, reported mail, block list and VIPs	Allow-list changes, console admin changes and organization-wide changes
Full Automation	Every read and write	Nothing

INKY marks most of its API as beta: those endpoints may change before INKY moves them to a stable version. If an INKY call starts to fail after an INKY update, tell Neo support. See INKY API for what the agent can read and change.

Getting started

Core

Triggered & Scheduled Agents

Chat Agents

Integrations

Product

Workflows

Customizing Neo

Connecting INKY to Neo

1. Create the API key

2. Add the key in Neo

3. Turn INKY on per agent

​1. Create the API key

​2. Add the key in Neo

​3. Turn INKY on per agent

1. Create the API key

2. Add the key in Neo

3. Turn INKY on per agent