Custom and Runbooks

Connecting Through the API

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/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.

Example of how to implement Request Signing for Integration Runbook Authentication

Iterative Runbooks

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

Using HaloDBLookupService to run custom integration methods on internally facing APIs

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.

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.