Summary
- Introduction
- Creating the Integration
- Add Feedback to Ticket Custom Fields
- Add Your Survey Snippet to Halo PSA
-
Introduction
Crewhu connects to HaloPSA through a REST API application. This integration brings your ticket data into Crewhu and sends survey results back to your Halo tickets. It’s available on all plans.
You need admin access to Halo’s configuration, a Halo agent account that meets the requirements below, and admin access in Crewhu to create the integration. For the permissions each Crewhu product needs, see Halo PSA Permissions.
-
Creating the Integration
Agent Account Requirements
The integration connects to HaloPSA through an agent account. That agent doesn’t need to be an Admin, but it must have a role with the right access. Otherwise, the integration authenticates successfully and still fails to return data.
Before creating the application, confirm the following for the agent you plan to use:
| Requirement | Details |
|---|---|
| Role assigned | The agent must have a Role. The field cannot be left blank. Admin is not required. |
| Role access levels | The role needs at least read-only access to: Clients Access Level, Tickets Access Level, and Users Access Level. |
| Application active | The Crewhu application in Halo must be marked as Active. |
Note:
These requirements are separate from the API application permissions you’ll set in the next step. Both need to be in place. For the full list of permissions each Crewhu product needs, see Halo PSA Permissions.
-
Get Your Credentials
Before setting up your integration inside Crewhu, you’ll need to get your HaloPSA API credentials. To do this, access the menu Configuration > Integrations > HaloPSA API > View Applications.
Click on New in the top right corner. Then, follow these steps to configure the integration.
- In the Permissions tab, select "read:tickets", "edit:tickets" and "read:customers".
- Name the Application with an intuitive name.
- Select "Client ID and Secret" as the Authentication Method
- Select the Login Type as "Agent" and select the Main User for Halo.
- Copy the ID and secret. The secret is shown only once. Make sure to take note of it. You'll need it later.
- Hit Save.
-
Create a New Integration in Crewhu
To create the integration with Halo, access the Integrations Page under General. Then, click on Add and select the HaloPSA on the menu.
Now, fill in the necessary data on the fields. Click on Test Integration and then Save.
- The application URL is the base URL of your company instance.
- The Client ID and Client Secret are your credentials.
Important: Make sure that the "Application URL" doesn't have any slashes ( / ) or symbols at the end, or else the Survey History ticket shortcuts will break.
-
If the Integration Test Fails
| Symptom | What to check |
|---|---|
| The credentials authenticate, but the test returns a 404 | The agent’s role is blank, or the role is missing read access to Clients, Tickets, or Users. Review the Agent Account Requirements above. |
| The test fails immediately | The Application URL has a trailing slash or symbol, or points to an endpoint instead of the base instance URL. |
| The test runs, but a product group is incomplete | A permission is missing from the API application. See Halo PSA Permissions. |
| Survey History ticket shortcuts don’t open | Trailing slash in the Application URL. |
-
Add Feedback to Ticket Custom Fields
Crewhu’s integration with Halo allows you to send the data from the last survey received to the PSA ticket. To do this, you need to manually create some fields in the ticket.
Note:
This requires the edit:tickets permission on your API application. Crewhu doesn’t create these fields for you.
To begin, navigate to Configurations -> Custom Fields:
On the Custom Fields screen, click New.
You will need to create 5 custom fields on this screen, repeating the operation for each of them. The data you will need to add is the following:
| Survey data | Field Name | Field Label |
|---|---|---|
| Survey Rating | CrewhuRating | Crewhu Rating |
| Survey Tags | CrewhuTags | Crewhu Tags |
| Survey Comments | CrewhuComment | Crewhu Comment |
| Survey Date | CrewhuFeedbackDate | Crewhu Feedback Date |
| Survey Link | CrewhuLink | Crewhu Link |
-
Setting the Tab Field
The Tab field must be changed to Crewhu for all records. If this option is not available in the list, click Add to add the Crewhu tab to the ticket.
Set the Tab Name to Crewhu.
The Sequence field defines the order in which the tab will appear on the ticket. To avoid changing the order of other tabs that may exist, set a high value, such as 99. This will ensure that the Crewhu tab is displayed at the end of the tab list. If you want it to appear earlier, set it to a lower number.
-
Adding Custom Fields to Tickets
After creating the custom fields, you need to add them to the ticket types you want.
To do this, navigate to Configurations > Ticket Types.
You will need to repeat this step for each ticket type to which you want to assign custom fields and display survey data. In this case, we will use the Incident ticket type as an example.
Click Edit and then select the Field List tab. At the bottom of the list, click Add.
Add all the fields that were created. Note that the fields now appear with the prefix CF (Custom Field). Click Save.
After the fields appear in the list, click Save again.
Done, the fields have now been added to the ticket. This is how they will appear:
-
Add Your Survey Snippet to Halo PSA
Note:
In order to have your surveys assigned to the correct employees, make sure that the Employee ID added to Crewhu matches the information from your PSA. Learn more about this here.
Firstly, go to Settings > CSAT and select the Integration Partner as HaloPSA, as shown:
Then, enable the Write survey back option. This will ensure that the custom fields populate correctly in Halo:
If you want to use the survey in the ticket responses, you need to copy the Reply survey snippet. If you want the survey to be sent only when the ticket is marked as complete/resolved, then you need to copy the Resolve survey snippet. Both snippets are on CSAT Settings.
Refer to this article to learn more about the Types of Surveys.
-
Resolved Surveys
Go to Configurations > Emails > Outgoing Email > Email Templates.
Locate the Ticket Closed template and click Edit. After that, select the Source button and paste the Resolved snippet.
After pasting the snippet, click the Source button again to preview the snippet and hit Save.
-
Reply Surveys
Reply surveys can be pasted on any update template because they allow multiple answers. To ensure the highest conversion rate possible, follow the same steps from the resolved surveys and place the snippet on every template applicable.
Best Practice
Double-check the snippet to make sure you copied the correct snippet.
Comments
0 comments
Please sign in to leave a comment.