Skip to main content

Integration Guide

1. Create Security Role

In your ConnectWise PSA instance, go to System→Security Roles where you can create a security role for Neo

Integration-1 Integration-2 Integration-3

  • Role ID => Neo
  • Click Save

2. Grant READ access

Read means Inquire in ConnectWise terms. Neo needs Inquire Level for the following:

Security ModuleEntryInquire Level
Service DeskService TicketsAll
Service DeskService Tickets - FinanceAll
Service DeskClose Service TicketsAll
Service DeskResource Scheduling (customize)All
Service DeskMerge TicketsAll
Service DeskService Ticket - DependenciesAll
ProjectClose Project ticketsAll
ProjectClose ProjectsAll
ProjectProject HeadersAll
ProjectProject NotesAll
ProjectProject PhaseAll
ProjectProject TicketsAll
ProjectProject ContactsAll
ProjectProject FinanceAll
ProjectProject ManagementAll
ProjectProject ReportsAll
ProjectProject TeamsAll
ProjectProject Ticket - DependenciesAll
ProjectProject Ticket TasksAll
CompaniesConfigurationsAll
CompaniesContactsAll
CompaniesTeam MembersAll
CompaniesCompany MaintenanceAll
CompaniesManage AttachmentsAll
CompaniesManagementAll
CompaniesNotesAll
CompaniesReportsAll
CompaniesContactsAll
Time & ExpenseTime EntryAll
Time & ExpenseTime Entry Billable OptionAll
Time & ExpenseReportsAll
SystemMember MaintenanceAll
SystemTable SetupAll
SystemMy CompanyAll
FinanceAgreementsAll
FinanceBilling View TimeAll
ProcurementProductsAll
System -> Table Setup

In customize menu everything is allowed by default. It's fine because it allows Neo to read metadata about companies, tickets, etc. from ConnectWise

3. Grant WRITE access

Neo Workflows can add Ticket Internal Notes and update Ticket Fields:

Security ModuleEntryAdd LevelEdit Level
Service DeskClose Service TicketsAllAll
Service DeskService TicketsAllAll
Service DeskService Ticket - DependenciesAllAll
Service DeskMerge TicketsAllAll
CompaniesContactsAllAll
Time & ExpenseTime EntryAllAll
Time & ExpenseTime Entry Billable OptionAllAll
FinanceBilling View TimeAllAll
CompaniesManage AttachmentsAllAll

Update Project Tickets:

Security ModuleEntryAdd LevelEdit Level
ProjectClose Project TicketsAllAll
ProjectClose ProjectsAllAll
ProjectProject Ticket - DependenciesAllAll
ProjectProject Ticket TasksAllAll
ProjectProject TicketsAllAll

Update My Company:

Security ModuleEntryAdd LevelEdit Level
SystemMy CompanyAllAll

Update Owner:

Security ModuleEntryAdd LevelEdit Level
Service DeskResource SchedulingAllAll

4. Create API member

  • With the Security Role created, let's create an API member for Neo.
    • Go to System → Members → API Members.
    • Create a new member by defining the following fields:
      • Role ID: Select the role ID created before;
      • email: team@neoagent.io
    • Define API Keys
      • Create a new API key for Neo by providing a description (e.g. "Neo-API").
      • You will be given a new Public and Private Keys;

5. Share API credentials with us

  • Please go to the (Dashboard)[https://dashboard.neoagent.io/integrations] and share with us the following information:
    • ID of the API member you created on step 4
      • We need the number-based ID, like 342
    • Public Key (”username” in Neo Dashboard)
    • Private Key (”password” in Neo Dashboard)
    • Your ConnectWise PSA URL (e.g. https://na.myconnectwise.net/)
    • Your company name exactly as it's set in ConnectWise. You can find it on the login screen:

Integration-4

6. Control the integration

Integration-5

The integration is now active. You can control it in the Dashboard.

  1. Sync is triggered automatically and happens every 8 hours
  2. You can trigger a sync manually by clicking on the Trigger Sync button.
    • It's useful when you want Neo to know about recent changes in Ticket Statuses, Board/Queue names, Companies, etc.

Advanced

  • Use PSA Sync Filters to control which tickets are imported from ConnectWise to Neo
tip

These filters only control which tickets are synchronized into Neo's database to be available for Similar Tickets search. They do not affect which tickets Neo can access through workflows.