Custom Integrations and Runbooks

Backend Services Monitoring

This article provides a comprehensive guide on Backend Services Monitoring using Halo. It explains how to monitor backend services such as automations, integration syncs, emails, and webhooks. The guide includes instructions to navigate the monitoring area, set log levels, manage background services, and conduct maintenance. It details various logs like task scheduler, incoming/outgoing emails, and events to troubleshoot issues. Additionally, it covers integration errors and monitoring events to help identify and resolve issues efficiently.

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.

Creating Report Data Within a Runbook (Matching and Merging to Existing Alert Tickets)

This article provides a guide on creating report data within a runbook and matching email alerts to existing alert tickets. It explains how to configure runbooks to pull data from a Halo database using SQL queries, and how to manage alert tickets by merging them based on a shared Alert Ticket ID. The article details the steps for creating and using runbook-level variables, setting up email rules to capture alert IDs, and configuring runbooks to update or merge tickets as new alerts arrive.

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.

Execute Automation Runbooks from the Chatbot

HaloAPI Full Documentation

Handling Attachments/Files in Runbooks

Iterative Runbooks

Runbook Level Variables

Runbook: Update Status of Child Tickets

Runbook: Update the Estimated Time Based on the Category Chosen

Runbooks - Authorising API Access into Your Own Halo Instance

Setting Up An API Agent

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

Webhook and Integration Runbook Access Control

This guide explains how to implement access control for webhooks and integration runbooks, allowing specific agents to configure selected webhooks and runbooks without full admin privileges. Agents with access can view and edit existing runbooks and webhooks but cannot create new ones; only administrators have creation rights. Access control is granted by the creator of a webhook/runbook and is managed through an 'Access Control' button. Access is assigned by roles or departments with varying levels, such as read and modify or owner. Each new runbook/webhook requires access settings.

Webhook To Trigger a Runbook

This article provides a detailed guide on setting up a webhook to trigger a runbook in Halo's Runbooks module. The process involves creating a new runbook, obtaining its URL for use as a webhook payload URL, and defining an event trigger, such as 'Invoice Created'. The guide explains how to configure settings, view logs, and utilize runbook-level variables, using the example of an Invoice ID. The runbook URL allows external triggers to initiate predefined sequences through POST requests.