Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Do the following steps to establish your Halo connection to Connecting HaloPSA to MSPbots lets you leverage automation and Business Intelligence (BI) solutions to manage every aspect of your MSP business. The integration is done by assigning the appropriate user permissions in HaloPSA, entering the integration settings in the MSPbots app, and configuring webhooks. This article provides the prerequisites and step-by-step guide to establishing a HaloPSA connection with MSPbots.

What's in on this articlepage:

Table of Contents

Secure the required information for your Halo account. 

Prerequisites for connecting HaloPSA to MSPbots  


You need the following to establish a successful HaloPSA integration with MSPbots: 

  • Correct permissions set in HaloPSA: 
    • Identify the user who will run the API and have access to the MSPbots app. Use the Agent to log in as field. 
      user log in asImage Added
    • Assign the appropriate permissions to the identified user. For example, granting the read:tickets permission will give MSPbots read-only access to all data to which the user has access. 
      read tickets permissionImage Added
    • Ensure the user is part of a department or team that has the corresponding permissions to access the relevant data. 
      department permissionsImage Added

Refer to the HaloPSA Guides for the instructions on setting up these permissions. 


  • Required information for configuring the integration in MSPbots: 
    • Auth URL

    • Resource URL

    • Tenant

    • Client ID

    • Client Secret

      Refer to the



    • for the instructions on setting up the API permission

How to set up the HaloPSA and MSPbots integration 


1. Complete the prerequisites for the integration


2. Submit the required information in the MSPbots app.  

    1. Log in to the MSPbots app and navigate to Integrations on the menu.
      image MSPbots integrations
    2. Search for Halo PSA and click it to open the connection settings.
      image Halo PSA integration

    3. When the Halo PSA HaloPSA configuration settings appear, fill in all of the following required fields:

      • Auth URL

      • Resource URL

      • Tenant

      • Client ID

      • Client Secret

        image Halo configuration
    4. Click Save And Sync when done. 
    5. Anchor
      webhook callback URL
      webhook callback URL
      You will know that Halo PSAHaloPSA's connection is successful when the webhook callback URL field appears on the configuration box. Copy the the value of webhook callback URL to your desktop.
      image webhook callback URL

Configure Halo Webhooks. 

3. Configure the 
HaloPSA webhook 

A webhook is required for HaloPSA dashboards to function properly. Configure the HaloPSA webhook according to the steps below. 


It is important to configure the webhook correctly. If not properly set, an incorrect webhook


Please configure the Halo Webhooks according to the following steps. If you fail to configure the Webhook correctly, it may affect the normal data synchronization adversely and trigger the HaloPSA's request limit rate limit of Halo ( 450 requests within 5 minutes). Configuring Webhook requests . A correct webhook configuration request ensures that the system does will not initiate duplicate synchronizations, thereby reducing the possibility of triggering the rate limit.

    1. When Once the field for webhook callback URL is visible, log in to the Halo PSA HaloPSA app. 
    2. Navigate to Configuration > Integrations > Webhooks.
      Image Removedwebhooks integrationImage Added

    3. Click New to open the New Webhook screen. Next, click New.
      new webhooks buttonImage Modified

    4. Fill in the fields for Webhook Name and Payload URL. You can leave the other fields with their default values.

      • Webhook Name - Enter a unique webhook name.
        webhook name payload URLImage AddedImage Removed

      • Payload URL - Enter the webhook callback URL from step Step 2.e in this field. 

    5. Anchor
      Next, click the Add button to add a new event. 
      new webhook eventImage Modified

    6. Anchor
      On the New Event screen, select Ticket Changed from the Event dropdown Event dropdown menu.
      Image Removednew event setupImage Added

    7. Anchor
      Click Save on the New Event screen. 

    8. Repeat stepsSteps 3.e3.f and 3.g until all the following events are added.
      • Ticket Changed
      • New Ticket Logged
      • Site created
      • Site updated
      • Site deleted
      • User created
      • User updated
      • User deleted
      • Invoice created
      • Invoice updated
      • Invoice deleted
    9. Then click Save on the New Webhook screen to keep the configuration.

What are the Webhook statuses and messages for the HaloPSA integration?  


The Webhook statuses for your HaloPSA interaction can show any of the following: 

Webhook Successful

Image Added

This means that all the data was received successfully.
Webhook received no data for some events

Image Added

This means that Webhook did not receive some data because of one of the following reasons: 

  • The webhook is not properly configured. Ensure correct configuration and refer to the section Configure the HaloPSA webhook
  • There is no new data from the webhook yet. Verify this by creating a new invoice, site, ticket, or user. 
Webhook received no data

Image Added

This means the webhook did not receive data because of the same reasons explained in the previous status message. Resolve this using the same recommendations for the previous message. 
Webhook received no data within 4 days

Image Added

This means that MSPbots has not received data from the webhook for the past 4 days. Ensure that all webhook events are properly configured according to the section Configure the HaloPSA webhook.

Related Topics 


Content by Label
cqllabel = "halo"