Custom Integrations

API Applications with Organisation access

Automated New Starter Requests into Microsoft Entra

This guide explains setting up automated onboarding for new users into Microsoft Entra using HaloPSA. It covers configuring Microsoft CSP integration, syncing user data, and using self-service portals. The functionality will be standard in instances from April 2025, with earlier versions able to download it by early 2026. The process includes setting up CSP in HaloPSA, importing tenants and users, setting Azure AD groups, and using an approval process before triggering Azure onboarding automation.

Best Practices for Claude Code in Halo

Connecting Through the API

Creating API Applications

This article guides users on configuring API applications in the Halo system, including details on API connections and application setup. It covers accessing API configuration for connection details, creating new applications, setting authentication methods (such as Client ID and Secret or static API Key), and using machine identity for application authorization. The guide also includes instructions for assigning roles and permissions to applications to ensure appropriate access control based on principle of least privilege.

Custom Integrations

This guide explains how to set up custom integrations in Halo, which are used for authenticating and executing requests to external APIs, allowing integration with other tools. It covers the process of creating custom integrations, choosing authorization methods, and setting up integration methods. Custom integration methods define the requests and endpoints for data exchange with other applications. The guide also explains using runbooks to execute these integration methods, detailing steps configuration, execution flow, and linking methods with multiple Halo instances for consistent functionality.

Custom Integrations/Runbooks

This article provides a comprehensive guide to creating and managing custom integrations and runbooks in the Halo platform. It covers the basic building blocks of runbooks, runbook statistics, various trigger options, and how to use output variables in subsequent steps. The guide also includes methods for integrating with external APIs, using Halo API actions, and securing sensitive data through encryption. Practical examples are given to illustrate the steps required to configure and use runbooks effectively, including triggering actions based on ticket workflows and custom buttons.

Filtering responses via the 'datesearch' query parameter

HaloAPI Full Documentation

Setting Up An API Agent

Triggering Automation Policies in RMM via Halo

Troubleshooting API Errors

This guide provides a comprehensive overview of API errors in the context of Halo, explaining how to interpret and resolve them using HTTP status and API error codes. API errors occur during interaction requests with Halo's API, manifesting in various ways. The article outlines how to identify these errors by using the console, where you can view HTTP status codes like 401, 403, 404, 405, 409, 422, 429, and 504, each indicating different issues ranging from unauthorized access to data requests, resource conflicts, and request timeouts. Resolution strategies are provided for each error scenario.

Using HaloDBLookupService to run custom integration methods on internally facing APIs

Using HaloDBLookupService to set up a Database Lookup for an external SQL Server Database

Using the Halo API

This article provides instructions on using the Halo API, including how to access the API Configuration, create an Application, and utilize examples for setup. It guides users through finding the necessary URLs and creating an API Application with permissions, credentials, and authentication methods like 'Client ID and Secret' or a static API Key. The article also highlights the option to download example configurations for Postman to assist with the setup process.