Skip to content

Connection

Hire2Retire connects to Halo using OAuth Authentication. Please refer to the document Halo API documentation to know more about OAuth Authentication in Halo.

We, at RoboMQ, pay utmost attention to keep your account secure. See our Security and Privacy Policies to learn more about how RoboMQ handles your account access.

Step 1 Create an Application in Halo

How to Create the application?

  1. Log into Halo admin center with appropriate permissions to configure API integrations Halo Admin Center

  2. On the Home screen, click the Configuration button (gear icons).

  3. Click Integrations under Advanced.

    Halo OAuth Client App

    Figure 1. Create Application on Halo App

  4. On the Integrations section in the Advanced navigation menu, click the HaloITSM API button.

    Halo OAuth Client App

    Figure 2. Provide necessary details on Halo App

  5. In the Applications section, click the View Applications button.

    Halo OAuth Client App

    Figure 3. Provide necessary details on Halo App

  6. In the top right corner, click on New.

    Halo OAuth Client App

    Figure 4. Provide necessary details on Halo App

  7. In the Add an Application screen, enter an Application Name, e.g. Lifecycle Manager

  8. Select Client ID and Secret (Services) as the Authentication Method.

    Halo OAuth Client App

    Figure 5. Provide necessary details on Halo App

  9. Under your newly created application, take note of the Client ID and the Client Secret.

  10. Copy the Client ID

  11. Copy the Client Secret

  12. Select Agent as Login Type.

  13. Once this configuration is complete, you need to assign roles and permissions to the agent.

Step 2. Assign User and Role Permissions

How to Select user and role permission?

  1. Click the Configuration button.

    Halo OAuth Client App

    Figure 6. Apps and Integration on Halo

  2. Click Teams & Agents on the left navigation bar..

    Halo OAuth Client App

    Figure 7. Add role on Halo

  3. Under the Teams & Agents button click Agent Roles and after that select IT Agent Role .

    Halo OAuth Client App

    Figure 8. Provide necessary details on Halo App

  4. Then click the Save button.


Step 3 Enable API Permissions

How to add API permissions?

  1. Switch to the Permissions tab and enable the required permissions.

    Halo OAuth Client App

    Figure 9. Halo permission for API

  2. Click the Edit button.

    Halo OAuth Client App

    Figure 10. Halo permission for API

  3. Select read:tickets, edit:tickets (if you want to manage tickets in the Hire2Retire workflow).

  4. Select read:assets (if you want to map assets in the workflow for any ticket type).

    Halo OAuth Client App

    Figure 11. Halo permission for API

  5. Click Save.

    Halo OAuth Client App

    Figure 12. Halo permission for API

Step 4 Connect Halo in Hire2Retire

Enter the Client ID and the Client Secret generated by the Halo app on the connection screen in Hire2Retire and copy the instance URL from your domain (e.g., https://robomq.haloitsm.com).

Halo OAuth Client App

Figure 13. Halo Connection on Hire2retire

Save the connection to complete setup.