Halo PSA Integration Guide
This guide provides step-by-step instructions for creating an API key within Halo, enabling integration with CYRISMA for efficient data management and communication
- User Manual
- Agents
- The Cyber Risk Assessment Process
- API Documents
- General Questions and Troubleshooting
- The Cyber Risk Assessment Process (Video Tutorials)
- Sales and Prospecting Articles
- CYRISMA Partner Portal Access
- Glossary
- CYRISMA Change Log
- Support Ticket SLA
- Onboarding Framework
- PSA Integrations
- Billing Questions
- Self Onboarding Guide
Table of Contents
1. Create API Key
To establish a connection between CYRISMA and Halo, you need to generate an API key.
Steps to Create an API Key:
Navigate to HaloPSA API:
- In the Halo user interface, go to Configuration > Integrations > HaloPSA API.

Create New API Key:
- Click on the ‘New’ button to begin the API key creation process.

Configure API Key Details:
- In the Details tab:
- Set the Authentication Method to ‘Client ID and Secret (Services)’.
- Set the Login Type to ‘Agent’.
- Assign an agent to log in with; note that the agent cannot be set to ‘None’.

Set Permissions:
- Switch to the Permissions tab and grant the following access:
- Read: Customers
- Read: Tickets
- Edit: Tickets

Configure Security Settings:
- Navigate to the Security tab and enter the host name where you want to receive the API requests.

Finalize the Creation:
- Once all settings are configured, finalize the creation of the API key by clicking the appropriate button to save your changes.
Conclusion
By following these steps, you will successfully create an API key within Halo, allowing for seamless integration with CYRISMA. Ensure that all settings are correctly configured for effective communication between the platforms. If you have any questions or need further assistance, please consult Halo's documentation or reach out to their support team.