Using HaloDBLookupService to run custom integration methods on internally facing APIs
In version 2.184+ there is a new connection option for Custom Integrations to connect to internally facing APIs: This connection method allows you to host a proxy application called "HaloDBLookupService" on your own network which can access your internally facing APIs. The Halo API then connects to this Service using requests signed by a common […]
Execute Automation Runbooks from the Chatbot
In this guide we will cover: – Introduction – How to trigger a Runbook from the chatbot – Use Chat Data in a Runbook – Keep the User updated on Runbook progress – Auditing the Runbook – Restrict the chat progress based on Runbook Result message Related Guides: Chat Bot and Chat Profiles Virtual Agents […]
Backend Services Monitoring
In this guide we will cover: – What is Backend Services Monitoring? – Navigating the Backend Services Monitoring area – Common Errors What is Backend Services Monitoring? Backend services monitoring in Halo allows you to monitor services, automations and events that run on the backend of Halo. This includes integration syncs, incoming and outgoing email, […]
Webhook To Trigger a Runbook
In this guide we will cover: – How to setup a webhook to trigger a runbook Within the Runbooks module of Halo you can generate a link to the runbook from which you can send payloads to. To begin configuring this, create a new runbook by navigating to Configuration > Integrations > Custom Integrations and […]
Runbook: Update the Estimated Time Based on the Category Chosen
Credits to – Connor Fagan (Video) and Robbie Emerson (Author of the Guide) from Renada. This Below video goes over the use case of this runbook and a high level overview of the set up. The purpose of this runbook is to update the estimated time field of a ticket, based off of the category […]
Runbooks – Authorising API Access into Your Own Halo Instance
In this guide we will cover: – Creating an API Application – Creating an API-Only Agent – Creating a Custom Integration Creating an API Application Within Halo you can create an API Application and then a custom integration, in order to perform GET's, POST's, etc… to API Endpoints in your Halo. For the purposes of […]
Creating Report Data Within a Runbook (Matching and Merging to Existing Alert Tickets)
In this guide we will cover: – Creating Report data within a Runbook – Worked Example – have email alerts merge based on alert ID – Copying The JSON From This Runbook Disclaimer: If this setup is something that you are finding difficult to configure, please contact support. The JSON can be imported for this […]
Setting Up An API Agent
In this guide we will cover: – Setting up an API Agent – Use of an API Agent API agent accounts do not take up licences, are free of charge and are used for accessing the Halo Integrator and API connections. Setting up an API Agent To set up an API agent account, go to […]
Iterative Runbooks
In this guide we will cover: – General Runbook Configuration – Iterating through the runbook – Runbook Scheduling – Additional Information Runbooks can be used to iterate through an array of data. This can be achieved by following the guide below. The first thing to consider when configuring runbooks is the authorization of the API. […]
How to start using the Halo API
In this guide we will cover: – Navigating to the API Configuration – Creating an Application – Examples Navigating to the API Configuration Go to Configuration > Integrations > Halo API. Here you will see the Resource Server URL and the Authorisation Server URL as well as your tenant name (if applicable). Fig 1. API […]
