HighGear Workflow
HighGear makes it easy to rapidly deploy and securely manage work, at scale. As a highly configurable no-code workflow platform, connecting with HighGear allows you to readily integrate business applications. Get your entire team connected across the enterprise and start building seamless workflows and processes with more visibility, auditability, and real-time measurement of all work activity.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - China Cloud operated by 21Vianet |
| Power Apps | Premium | All Power Apps regions except the following: - China Cloud operated by 21Vianet |
| Contact | |
|---|---|
| Name | HighGear Support |
| URL | https://www.highgear.com/support/ |
| support@HighGear.com |
| Connector Metadata | |
|---|---|
| Publisher | HighGear Software, Inc. |
| Website | https://www.highgear.com |
| Privacy policy | https://www.highgear.com/platform-privacy-policy/ |
| Categories | Business Management;Collaboration |
With the HighGear Workflow connector, it's never been easier to rapidly integrate business applications and mission critical work. HighGear's enterprise-grade security meets the rigors of the most highly regulated industries while allowing everyday business users to rapidly build simple to complex workflows. Assign tasks, manage work, track progress, and report the status of activity in real time using HighGear's no-code workflow and process management platform. Easily and securely.
If you're interested in learning more about the HighGear platform, schedule a demo or contact us.
Prerequisites
To use this connector, you will need the HighGear application, version 9.1.0 or above.
You will also need the following:
- The base URL of your HighGear system:
This is the part of the URL you see in your web browser address bar without the specific page you're on.
The two most common patterns of base URL are
https://SUBDOMAIN.example.comwhere SUBDOMAIN is "highgear" or something similar orhttps://example.com/highgear. - An integration account and API key: This is necessary so that the connector can communicate with the HighGear REST API. To learn how to create an integration account, go to the help in your HighGear system and search for the article Creating an Integration Account.
How to get credentials
To set up and use the connector, you will need an integration account in your HighGear system with an API key.
Please go to the help in your HighGear system and refer to the following articles to learn how to set up an integration account and create an API key for it.
- Creating an Integration Account
- Creating an Integration API Key for an Account
Get started with your connector
To get started with the HighGear Workflow connector and to trigger a flow when a task enters a workflow web request node in your HighGear system, follow these steps:
- Create a HighGear Workflow connection if not created. For a new connection, enter the base URL and subdomain for your HighGear system in addition to the API Key for your integration account.
- Add a When a task enters a web request node trigger and select a HighGear workflow and node. This will trigger your flow when a task enters the selected workflow node.
- Add a Get task action to get data from the task. Use the Task Id from the When a task enters a web request node trigger and select the task form with the data fields you want to load.
- Add another connector to send task data to. Some common use cases are to create an Outlook event from the start and end date of a HighGear task, send an email about a task to the assignee's email address, or update the status of a corresponding record in another system.
Known issues and limitations
- Additional data (i.e. Task Fields to Send) included with outbound web requests from a HighGear workflow is not currently supported with the connector. For now, get the data you need via the Get task action after receiving a trigger from your HighGear system.
For issues with the HighGear Workflow connector, please contact HighGear support.
FAQ
- How do I look up a help article?
- To look up a help article in your HighGear system, click the Help button in the upper right corner.
A new tab will open with the HighGear user documentation. - Click the Search button, represented by a magnifying glass icon, in the upper right corner.
- In the Search textbox, type the name of the article you want to open.
A dropdown list will show the search results.* - Click the name of the article.
- To look up a help article in your HighGear system, click the Help button in the upper right corner.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API key for the HighGear REST API | True |
| Host Name | string | Specify your HighGear host name (e.g. test.highgear.app) | True |
| Subdirectory | string | Specify your subdirectory (e.g. dev or prod) |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create contact |
Use this action to create a new contact (individual, organizational unit, permission group, asset, or queue) in your HighGear system. This action returns the ID of the new contact. |
| Create task |
Use this action to create a new task in your HighGear system. This action returns the ID of the new task. |
| Delete contact file |
Use this action to delete a file attached to a contact in your HighGear system. |
| Delete task file |
Use this action to delete a file attached to a task in your HighGear system. |
| Get contact |
Use this action to get the field values for a contact in your HighGear system. |
| Get contact file content |
Use this action to get a file attached to a contact in your HighGear system. |
| Get task |
Use this action to get the field values for a task in your HighGear system. |
| Get task file content |
Use this action to get a file attached to a task in your HighGear system. |
| Search contacts |
Use this action to search for contacts in your HighGear system. The search is based on the field criteria of a specified contact type. This action returns the ID, name, and email address of the contacts that match the search criteria. |
| Search tasks |
Use this action to search for tasks in your HighGear system. The search is based on the field criteria of a specified task form. This action returns the ID, and brief description of the tasks that match the search criteria. |
| Update contact |
Use this action to update the contact type fields for a contact in your HighGear system. This action returns the ID of the contact that was modified. |
| Update task |
Use this action to update the task form fields of a task in your HighGear system. This action returns the ID of the task and a boolean stating the task was modified (true or false). |
Create contact
Use this action to create a new contact (individual, organizational unit, permission group, asset, or queue) in your HighGear system. This action returns the ID of the new contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Class
|
contact_class | True | string |
The contact classification |
|
Contact Type
|
contact_type | True | integer |
The contact type of the new contact |
|
model
|
model | True | dynamic |
The field data for the new contact |
Returns
Create contacts response
Create task
Use this action to create a new task in your HighGear system. This action returns the ID of the new task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Form
|
job_type | True | integer |
The task form of the new task. |
|
model
|
model | True | dynamic |
The field data for the new task. |
Returns
Task create response
- Body
- TaskCreateResponse
Delete contact file
Use this action to delete a file attached to a contact in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Id
|
fileId | True | integer |
The contact file identifier |
Returns
- response
- object
Delete task file
Use this action to delete a file attached to a task in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Id
|
fileId | True | integer |
The task file identifier |
Returns
- response
- object
Get contact
Use this action to get the field values for a contact in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | integer |
The contact identifier |
|
Contact Class
|
contact_class | True | string |
The contact classification |
|
Contact Type
|
contact_type | True | integer |
The contact type with the fields to be retrieved. |
Returns
Get contact file content
Use this action to get a file attached to a contact in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Id
|
fileId | True | integer |
The contact file identifier |
Returns
The content of the file.
- File Content
- binary
Get task
Use this action to get the field values for a task in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
taskId | True | integer |
The task identifier |
|
Task Form
|
job_type | True | integer |
The task form with the fields to be retrieved. |
Returns
Get task file content
Use this action to get a file attached to a task in your HighGear system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Id
|
fileId | True | integer |
The task file identifier |
Returns
The content of the file.
- File Content
- binary
Search contacts
Use this action to search for contacts in your HighGear system. The search is based on the field criteria of a specified contact type. This action returns the ID, name, and email address of the contacts that match the search criteria.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Class
|
contact_class | True | string |
The contact classification |
|
Contact Type
|
contact_type | True | integer |
The contact type with the fields to be used as search criteria. |
|
model
|
model | True | dynamic |
Returns
- response
- array of Contact
Search tasks
Use this action to search for tasks in your HighGear system. The search is based on the field criteria of a specified task form. This action returns the ID, and brief description of the tasks that match the search criteria.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Form
|
job_type | True | integer |
The task form with the fields to be used as search criteria. |
|
model
|
model | True | dynamic |
Returns
- response
- array of TaskSearchResponse
Update contact
Use this action to update the contact type fields for a contact in your HighGear system. This action returns the ID of the contact that was modified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | integer |
The contact identifier |
|
Contact Class
|
contact_class | True | string |
The contact classification |
|
Contact Type
|
contact_type | True | integer |
The contact type with the fields to be updated. |
|
model
|
model | True | dynamic |
The fields to be updated for the specified contact. |
Returns
Create contacts response
Update task
Use this action to update the task form fields of a task in your HighGear system. This action returns the ID of the task and a boolean stating the task was modified (true or false).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
taskId | True | integer |
The task identifier |
|
Task Form
|
job_type | True | integer |
The task form with the fields to be updated. |
|
model
|
model | True | dynamic |
The fields to be updated for the specified task. |
Returns
Edit task response
- Body
- TaskEditResponse
Triggers
| When a task enters a web request node |
This action triggers a new flow when a task enters a Make Web Request node within a workflow defined in your HighGear System. |
When a task enters a web request node
This action triggers a new flow when a task enters a Make Web Request node within a workflow defined in your HighGear System.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
workflow_id | True | integer |
The workflow that contains the Make Web Request node that will trigger the flow. |
|
Node
|
node_id | True | integer |
The Make Web Request node that will trigger the flow. |
|
Name
|
label | True | string |
The name of the subscription created for the Make Web Request node. This name will be displayed in the list of Active Subscriptions for the node. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
jobId | integer |
The Id of the task that is executing this action |
|
Logged In User Id
|
loggedInUser | integer |
The Id of the logged in user when the workflow was executed |
Definitions
TaskCreateResponse
Task create response
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
task_id | integer |
The identifier of the new task |
|
Upload Failures
|
upload_failures | array of string |
The list of upload failure strings if any file upload operations failed. |
TaskEditResponse
Edit task response
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
task_id | integer |
The task identifier |
|
Was Task Modified
|
was_task_modified | boolean |
States (true or false) the task was changed as a result of the action. |
|
Upload Failures
|
upload_failures | array of string |
The list of upload failure strings if any file upload operations failed. |
TaskSearchResponse
Task search response
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
task_id | integer |
The task identifier |
|
Brief Description
|
brief_description | string |
The brief description for the task |
Contact
| Name | Path | Type | Description |
|---|---|---|---|
|
Contact Id
|
contact_id | integer |
The contact identifier |
|
Name
|
name | string |
The contact's name |
|
Email Address
|
email_address | string |
The contact's email address |
CreateContactResponse
Create contacts response
| Name | Path | Type | Description |
|---|---|---|---|
|
Contact Id
|
contact_id | integer |
The identifier of the new contact |
|
Upload Failures
|
upload_failures | array of string |
The list of upload failure strings if any file upload operations failed. |
object
This is the type 'object'.
binary
This is the basic data type 'binary'.