Skip to main content
You connect ICUK once at the MSP level. The API user acts on every service of your ICUK reseller account, with the permissions you give it in ICUK.

1. Create the API user

1

Open the ICUK control panel

Sign in to the ICUK control panel at control.icuk.net as an admin, and open the API users.
2

Add an API user

Create an API user for Neo, and give it the permissions for the services you want Neo to use: broadband, VoIP, domains, hosting and email, and the rest. Note its user name and password. Neo reads only the areas the API user may use. When you take a permission away later, the records Neo mapped from that area stay on the Organization Mapping tab, and ICUK refuses Neo’s calls about them.
3

Allow Neo's addresses

If the API user has an IP restriction, add Neo’s IP addresses to it. Otherwise ICUK refuses Neo’s calls.

2. Add the API user in Neo

1

Open Integrations

In the Neo Dashboard, open Integrations and find the ICUK card, under Networking (it also shows under Phone & VoIP).
2

Save the API user

Enter the API User Name and API User Password, and click Save settings. Neo signs in to ICUK before saving, so a wrong value is rejected straight away.

3. Turn ICUK on per agent

Open the agent, go to its Tools & Settings tab, click Networking, and expand the ICUK block. Pick a preset, or set each area yourself: These always ask a technician, whatever the preset:
  • deleting or ceasing a core record: a line’s account, a cease order, a domain, a VoIP account or number, a hosting account and its databases, a customer, and removing the spam filter;
  • anything that changes where a client’s web, mail, calls, voicemail or invitations go, or sends out: DNS, a mail forwarder, the catch-all, a group address recipient, call forwarding, a ring group’s members and alert email, a follow-me, voicemail sent to email, meeting invitations, an auto-responder, and sending an SMS;
  • anything that weakens a client’s mail protection: the spam filter’s settings, its allow and block entries, releasing queued mail, and deleting or deactivating a DKIM key;
  • adding, changing or enabling a cron job;
  • any change that sets a password, a PIN or a transfer code.
Neo hides every password, PIN and transfer code in what it reads from ICUK.

Use it on tickets

Map each client’s records on the Organization Mapping tab first: on a ticket, the agent reaches only the records mapped to the ticket’s company.
  • Broadband: the agent reads the line’s status, its recent sessions and sign-ins, and ICUK’s network notices for that line, then runs the line test that fits the line’s carrier (TalkTalk, or Openreach for BT Wholesale lines) and notes what it found.
  • Phones: the agent reads whether the user’s phone is online, its recent sign-ins and when it last fetched its settings, and says whether it needs provisioning again.

Domain renewal alerts

A scheduled agent with ICUK’s Domains group reads the domains that expire in the next month and flags each one whose auto-renew is off, with its client and expiry date. It checks the client’s open tickets for the domain first, so it opens one ticket per domain. Say in the agent’s instructions how to tell you: a ticket on the client’s company, or a message to your team. A chat or a scheduled agent with no ticket can read every client’s records, for example to list the phones that are offline. See ICUK API for what the agent can read and change.