Runbook Level Variables

In this guide we will cover:  – What are Runbook Level variables?  – Creating Runbook Variables – Configuring Variables – Worked Example Related Guides:  Custom Integrations/Runbooks Custom Integrations What are Runbook Level Variables?  When obtaining data from the API chances are you are not going to want the entire response body, but only particular parts of […]

Log Retention

In this guide we will cover: – What Logs Halo Stores and for How Long Related Guides: Backend Service Monitoring Redact Sensitive Audit Logs on a Ticket Redacting Card and Social Security Numbers (SSNs) What Logs Halo Stores and for How Long This table covers the basis of the most commonly referenced logs within the […]

HaloAPI Full Documentation

In addition to a simplified API documentation that can be found at <Your Halo URL>/apidoc/info, there is a full documentation of all endpoints available at usehalo.com/swagger.

Handling Attachments/Files in Runbooks

In this guide we will cover: – Attachment Endpoint – Sending Files in your Halo Instance to another Halo Instance or to Another Tool as Form Data – Sending Files in your Halo instance to another Halo instance or to another tool as a Downloadable Link – Obtaining Files from another Tool – Obtaining Attachment […]

Custom Integrations

In this guide we will cover: – What are Custom Integrations? – Creating a Custom Integration – Custom Integration Methods  – Executing Custom Integration Methods – Runbooks What are Custom Integrations? Custom Integrations in Halo are used to authenticate access and execute requests to other APIs. This allows you to integrate your Halo instance with […]

Troubleshooting API Errors

In this guide we will cover: – What are API errors  – How to obtain and interpret API errors in Halo – HTTP Status Codes – Error Examples in Halo In this guide we will cover what each of the HTTP status codes and API error codes means in the context of Halo and how […]

Webhook and Integration Runbook Access Control

In this Guide we will cover: – What is Webhook and Integration Runbook Access Control?  -Giving Access Control  What is Webhook and Integration Runbook Access Control?  Access control can be set against integration runbooks and webhooks to allow certain agents configuration access to selected webhooks and runbooks. This allows you to grant configuration access to […]

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 Related Guides: Log Retention What is Backend Services Monitoring?  Backend services monitoring allows you to monitor services, automations and events that run on the backend of Halo. This includes integration syncs, incoming and […]