Phin Security

ConnectWise Manage Integrations

The document provides detailed instructions for integrating Phin with ConnectWise Manage, including steps to start the integration, required fields (Company ID, API URL, Public and Private Keys), how to obtain these values, and how to create a custom security role with specific permissions for billing and service desk features to enable proper API access.

Connect Phin to Your ConnectWise Manage Account

Follow these instructions to properly configure the necessary permissions, security roles, and API members required to push data from Phin to your ConnectWise Manage environment.

Steps to Connect Phin & ConnectWise Manage

  1. 1.

    Start Integration

    • Click on any of the ConnectWise Manage integration tiles on the Integrations page at the partner level.
  2. 2.

    Required Fields

    • There are four required fields to connect Phin to your ConnectWise Manage account:
      • Company ID
      • ConnectWise API URL
      • Public Key
      • Private Key
    • Review and configure the correct permission set in your ConnectWise account as a pre-requisite for each feature (Billing permissions, Service Desk permissions) prior to connecting.
  3. 3.

    Obtain Required Field Values

    • Go to your ConnectWise Manage login page. Two required fields are located here:
      • Company ID (Company field)
      • ConnectWise API URL (URL used to log into ConnectWise)
    • Alternatively, go to System > My Company and view the name in the system URL.
  4. 4.

    Create Security Role

    • Create a new Security Role to assign to the new API member you will create for generating the Public Key and Private Key. Skip this step if assigning the API member the "Admin" role.
      • Go to System > Security Roles and select the + to create a new role.
      • Name the new role "Phin Integration" and save.
      • Set the following Security Module permissions for this role and save:
        • For Billing feature integration:
          • Companies > Company Maintenance > Inquire Level (All)
          • Finance > Agreements > Edit Level (All)
          • Finance > Agreements > Inquire Level (All)
        • For Service Desk feature integration:
          • Companies > Company Maintenance > Inquire Level (All)
          • Companies > Manage Attachments > Add Level (All), Inquire Level (All)
          • Companies > Contacts > Inquire Level (All)
          • Service Desk > Service Tickets > Add Level (All), Inquire Level (All)
  5. 5.

    Create API Member

    • Go to System > Members > API Members and select the + to create a new API Member.
    • Name the Member ID and Member Name.
    • If enabling the Service Desk feature, assign the API member a Default board under Service Defaults > Service Board > Default Board.
      • To add a service board:
        • Log in to the ConnectWise Manage dashboard.
        • Click System, then Setup Tables.
        • Enter Service Board under the table column.
        • Click the row from the search results.
        • Click the New Item icon.
        • Enter a name for the new board.
        • Select a location, business unit, and signoff template.
        • Click Save.
    • Add the system-required fields, selecting the "Phin Integration" Role ID you created.
    • Go to the API Keys tab and select the + to create your required API keys.
    • Add a name in the description field and save.
    • After generating the Public and Private Key, navigate back to the Phin ConnectWise configuration page and add them to their respective fields.
  6. 6.

    Complete Integration in Phin

    • Enter all required fields in Phin and select Connect to continue to the "Integrations" tab, where you can turn each feature on or off.
    • This page is also where you can disconnect Phin from ConnectWise. If you disconnect, the mapping of company names will be saved, but you will no longer be able to push billing data or create service tickets to ConnectWise Manage.

Remediation Steps for Incorrect Permissions

If you did not select all the correct Security Module permissions in your ConnectWise Manage account:

  1. 1.Log back into ConnectWise Manage.
  2. 2.Update the security module permissions under the "Phin Integration" role.
  3. 3.Save your changes.

Feature Comparison Table

FeatureConnectWise Manage Billing IntegrationConnectWise Manage Service Desk Integration
PurposePushes billable user data from Phin to ConnectWise Manage for billing and reporting purposes.Creates service tickets in ConnectWise. Manages emails reported via Phin's "Report Phishing" button in Outlook.
Prerequisites- Create the necessary security role and API member in ConnectWise Manage.
  • Configure specific permissions:
    • Companies: Company Maintenance (Inquire Level - All), Manage Attachments (Add Level - All), Inquire Level (All)
    • Finance: Agreements (Inquiry Level), Agreements (Edit Level) | - Proper configuration of the "Report Phishing" button for Outlook in Phin.
  • Create the necessary security role and API member in ConnectWise Manage.
  • Assignment of a default service board during API Member setup.
  • Configure specific permissions:
    • Companies: Company Maintenance (Inquire Level - All), Manage Attachments (Add Level - All), Inquire Level (All)
    • Companies: Contacts - Inquire Level (All)
    • Service Desk: Service Tickets (Add Level - All), Inquire Level (All) | | Company Mapping | Allows mapping of Phin companies to ConnectWise companies using fields such as ConnectWise Company, ConnectWise Agreement, and ConnectWise Addition. Supports both auto-mapping and manual mapping. | Allows mapping of Phin companies to ConnectWise companies using the ConnectWise Company field. Supports both auto-mapping and manual mapping. | | Functionality | - Maps Phin companies to ConnectWise companies.
  • Pushes billable user data to ConnectWise Manage for billing and reporting. | - Maps Phin companies to ConnectWise companies.
  • Creates service tickets in ConnectWise Manage when users report phishing emails using Phin's "Report Phishing" button.
  • Includes information in the service ticket such as the email subject line, security results, sender and reporter email addresses, and attachments. | | Additional Notes | - The mapping between the billing and service desk integrations is shared, so mapping needs to be done only once. | - The "Report Phishing" button must be configured appropriately for companies to create service tickets.
  • The integration only maps the Company Name from Phin to the Service Desk Board when a ticket is created. If contact information for a company representative is already set up in ConnectWise, that information will be included in the ticket. |

Knowledge Base

Phin updates the Knowledge Base with new features with every release. You can read about the platform and its updates at: https://www.phinsec.io/knowledge

Feedback is welcome to help drive Phin's development direction. All ideas are welcome!

If you need help or have an idea, you can submit it through the Knowledge Base.