Performing Ticket Approvals via API

1. Get Ticket Information First, retrieve the ticket details by making a GET request to: /api/tickets/{ticket_id} The response will contain an approvers array. Each approver entry contains: name – The approver's display name emailaddress – The approver's email user_id – The approver's user ID seq – Required for approval submission actionnumber – Required for approval […]

Halo Chat Widget Properties and Examples (v2.172+)

Quickstart You can embed chat on your website by adding the following to the end of your html body. You can retrieve your chat config id and key from Config > Chat > Chat Profiles, in the Halo Agent Application. <div id="halo-chat"></div> <script> var haloChatConfig = { chatServiceUrl: "https://yourHaloUrl.com/api", configId: "your-chat-config-id", configKey: "your-chat-config-key" } </script> […]

Virtual Agent and Azure AI Search

In this guide we will cover: – Connecting to Azure – Using AI Search – Virtual Agents Halo can be integrated with Azure AI Search for Knowledge Searching. The Azure AI Search integration allows you to create a search index for Knowledge Base articles and Services to perform AI similarity-matching searches. Connecting to Azure This can […]

Setting up NHServer as a Scheduled Task

Essentially, NHServer is the program that processes all items in and out of the database, such as emails, calendar appointments and so on.  The program is run interactively (opened, and “Start Repeated Scan” clicked), where it will continue to poll, as long as there is a logged in session. However, some prefer not to do […]

Setting up an API Agent

Setup When setting up an API Agent (or any agent that is going to use the API) to use with an API Application it is important to understand the permissions that the API Application is given. The permissions are a cross between the API Application as well as the  Agent that is nominated to run […]

Connecting Through the API

In this guide we will cover: – Importing Data – Authentication – Resources and Data – Common Issues Connecting to our API could not be simpler. Building your own integration with Halo is all explained in our API documentation. This can be found by going to your Halo URL and adding "/apidoc" to the end.  […]

Allowing your Portal to be Externally Accessible

This guide will explain how to make your end-user portal externally available. Related Guides: Self-Service Portal Customisation Making your end-user portal externally available can be a useful tool in allowing your customers to track their tickets and assets, easily see the services you offer them, and even use a knowledge base for your most frequently […]

Logging to a Database instead of the File Structure

How do I get the web app to log errors to a database instead of the file structure. From 0.57.2 onwards; In both the api and auth's appsettings.json, add the following ConnectionString for LoggerConnection, with the value being the connection string of the database to log to. Create the event log table in the database […]