Hubstaff
The Hubstaff modules allow you to watch, create, update, list, and delete the invites, projects, tasks, clients, team invoices, client invoices, attendance schedules, and attendance shifts in your Hubstaff account.
Getting started with Hubstaff
Prerequisites
- A Hubstaff account - create an account at hubstaff.com/.
The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!
Connecting Hubstaff to Integromat
1. Log in to your Integromat account, add a module from the Canvas LMS app into an Integromat scenario.
2. Click Add next to the Connection field.
3. In the Connection name field, enter a name for the connection and click Continue.
4. Confirm the access by clicking Authorize.
The connection has been established.
Organizations
List Organizations
Retrieves a list of organizations.
| Connection | Establish a connection to your Hubstaff account. |
| Limit | Set the maximum number of results Integromat should return during one execution cycle. |
Invites
List Invites
Retrieves a list of invites.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose invites you want to list. |
| Enter (map) the email address to search for the pending invitations that match the specified email. | |
| Status | Select or map the status of the invites you want to list.
|
| Limit | Set the maximum number of results Integromat should return during one execution cycle. |
Get an Invite
Retrieves a specific invite.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Enter (map) the Organization ID whose invite details you want to retrieve. |
| Invite ID | Enter (map) the Invite ID whose details you want to retrieve. |
Invite a User
Invites a specific user to the organization.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID to which you want to invite the user. |
| Project ID | Enter (map) the Project ID to which the user belongs. |
| Email to Invite | Enter (map) the email address of the user to send the invite. |
| Role | Select or map the role of the user you want to invite.
|
| Pay Rate | Enter (map) the pay rate of the user. |
Update a Pending Invite
Updates a pending invite.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose pending invite details you want to update. |
| Invite ID | Select or map the pending Invite ID whose details you want to update. |
| Project IDs | Select or map the Project IDs to which the user belongs. |
| Role | Select or map the role of the user:
|
| Pay Rate | Enter (map) the pay rate for the user. |
Delete an Invite
Deletes a specific invite.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose invite you want to delete. |
| Invite ID | Select or map the Invite ID you want to delete. |
Projects
Watch Projects Created
Triggers if projects have been created.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose projects you want to watch. |
| Limit | Set the maximum number of projects Integromat should return during one execution cycle. |
List Projects
Retrieves a list of projects.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose projects you want to list. |
| Status | Select or map the status of the project you want to list.
|
| Limit | Set the maximum number of projects Integromat should return during one execution cycle. |
Get a Project
Retrieves a specific project.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose projects details you want to retrieve. |
| Project ID | Select or map the Project ID whose details you want to retrieve. |
Create a Project
Creates a new project.
| Connection | Establish a connection to your Hubstaff account. | ||||||||
| Name | Enter (map) a name for the organization. | ||||||||
| Organization ID | Select or map the Organization ID whose projects you want to create. | ||||||||
| Client ID | Select or map the Client ID whose projects you want to create. | ||||||||
| Description | Enter (map) the project details. | ||||||||
| Billable | Select whether the project is billable. | ||||||||
| Members | Add members to the project: Organization ID Select or map the member's Organization ID. Role Select the member's role:
| ||||||||
| Budget | Select or map the budget type:
| ||||||||
| Cost | Add the cost details of the project:
| ||||||||
| Hours | Add the hour's details of the project:
|
Update a Project
Updates a specific project.
| Connection | Establish a connection to your Hubstaff account. | ||||||||
| Organization ID | Enter (map) the Organization ID whose projects you want to update. | ||||||||
| Project ID | Enter (map) the Project ID whose project details you want to update. | ||||||||
| Client ID | Enter (map) the Client ID whose projects you want to update. | ||||||||
| Name | Enter (map) the name of the project you want to update. | ||||||||
| Description | Enter (map) description of the project you want to update. | ||||||||
| Billable | Select whether the project is billable. | ||||||||
| Status | Select the status of the project:
| ||||||||
| Budget | Select or map the budget type:
| ||||||||
| Cost | Update the cost details of the project:
| ||||||||
| Hours | Update the hour's details of the project:
|
Tasks
Watch Tasks Created
Triggers if new tasks have been created.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose project tasks you want to watch. |
| Project ID | Select or map the Project ID whose tasks you want to watch. |
| Limit | Set the maximum number of tasks Integromat should return during one execution cycle. |
Watch Tasks Completed
Triggers if some tasks have been completed.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose project's completed tasks you want to watch. |
| Project ID | Select or map the Project ID whose completed tasks you want to watch. |
| Limit | Set the maximum number of tasks Integromat should return during one execution cycle. |
List Tasks
Retrieves a list of tasks.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose project's tasks you want to list. |
| Project ID | Select or map the Project ID whose tasks you want to list. |
| User IDs | Select or map the User ID whose tasks you want to list. |
| Status | Select or map the status of the task you want to list. |
| Limit | Set the maximum number of tasks Integromat should return during one execution cycle. |
Get a Task
Retrieves a specific task.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose project task's details you want to retrieve. |
| Project ID | Select or map the Project ID whose task details you want to retrieve. |
| Task ID | Select or map the Task ID whose details you want to retrieve. |
Create a Task
Creates a new task.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID for which you want to create the task. |
| Assignee ID | Select or map the Assignee ID to whom you are want to assign the task. |
| Project ID | Select or map the Project ID to which the task belongs to |
| Summary | Enter (map) the details of the task. |
Update a Task
Updates a specific task.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose project task details you want to update. |
| Project ID | Select or map the Project ID to which the task belongs to |
| Task ID | Select or map the Task ID whose details you want to update. |
| Assignee ID | Select or map the Assignee ID to whom you are want to assign the task. |
| Summary | Enter (map) the details of the task. |
| Lock Version | Enter (map) the version of the task you want to lock. For example, 0. |
| Status | Select or map the status of the task:
|
Delete a Task
Deletes a specific task.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose task you want to delete. |
| Project ID | Select or map the Project ID whose tasks you want to delete. |
| Task ID | Select or map the Task ID you want to delete. |
Clients
Watch Clients Created
Triggers if new clients have been created.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose clients you want to watch. |
| Limit | Set the maximum number of clients Integromat should return during one execution cycle. |
List Clients
Retrieves a list of clients.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose clients you want to list. |
| Status | Select or map the status of the clients you want to watch.
|
| Limit | Set the maximum number of clients Integromat should return during one execution cycle. |
Get a Client
Retrieves a new client.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose clients details you want to retrieve. |
| Client ID | Select or map the Client ID whose details you want to retrieve. |
Create a Client
Creates a new client.
| Connection | Establish a connection to your Hubstaff account. | ||||||||
| Name | Enter (map) a name for the client. | ||||||||
| Organization ID | Select or map the Organization ID for which you want to create the client. | ||||||||
| Project IDs | Select or map the Project IDs associated with the client. | ||||||||
| Address | Enter (map) the client address information. | ||||||||
| Emails | Add the email addresses of the client. | ||||||||
| Phone | Enter (map) the phone number of the client. | ||||||||
| Invoice Notes | Enter (map) the invoice information of the client. | ||||||||
| Net Terms | Enter (map) the number of days the invoice must be paid once created. | ||||||||
| Budget | Select or map the budget type:
| ||||||||
| Cost | Add the cost details of the client:
| ||||||||
| Hours | Add the hour's details of the client:
|
Update a Client
Updates a certain client.
| Connection | Establish a connection to your Hubstaff account. | ||||||||
| Organization ID | Select or map the Organization ID whose clients details you want to update. | ||||||||
| Client ID | Select or map the Client ID whose details you want to update. | ||||||||
| Project IDs | Add the Project IDs associated with the client. | ||||||||
| Address | Enter (map) the client address information. | ||||||||
| Emails | Add the email addresses of the client. | ||||||||
| Phone | Enter (map) the phone number of the client. | ||||||||
| Invoice Notes | Enter (map) the invoice information of the client. | ||||||||
| Net Terms | Enter (map) the number of days the invoice must be paid once created. | ||||||||
| Budget | Select or map the budget type:
| ||||||||
| Cost | Add the cost details of the client:
| ||||||||
| Hours | Add the hour's details of the client:
|
Team Invoices
List Team Invoices
Retrieves a list of team invoices.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose team invoices you want to list. |
| User IDs | Select or map the User IDs whose team invoices you want to list. |
| Status | Select or map the status of the invoice you want to list:
|
| Include Line Items | Select whether to include the line items in the invoice. |
| Limit | Set the maximum number of invoices Integromat should return during one execution cycle. |
Client Invoices
List Client Invoices
Retrieves a list of client invoices.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose client invoices you want to list. |
| Client IDs | Select or map the Client IDs whose invoices you want to list. |
| Status | Select or map the status of the invoice you want to list:
|
| Include Line Items | Select whether to include the line items in the invoice. |
| Limit | Set the maximum number of invoices Integromat should return during one execution cycle. |
Attendance Schedules
Watch Schedules Created
Triggers if new schedules have been created.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose schedules you want to watch. |
| Limit | Set the maximum number of schedules Integromat should return during one execution cycle. |
Watch Schedules Updated
Triggers if schedules have been updated.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose updated schedules you want to watch. |
| Limit | Set the maximum number of schedules Integromat should return during one execution cycle. |
Attendance Shifts
Watch Early Shifts
Triggers if shifts have become early.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose early shifts you want to watch. |
| Limit | Set the maximum number of early shifts Integromat should return during one execution cycle. |
Watch Missed Shifts
Triggers if shifts have been missed.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose missed shifts you want to watch. |
| Limit | Set the maximum number of missed shifts Integromat should return during one execution cycle. |
Watch Late Shifts
Triggers if shifts have been late.
| Connection | Establish a connection to your Hubstaff account. |
| Organization ID | Select or map the Organization ID whose late shifts you want to watch. |
| Limit | Set the maximum number of late shifts Integromat should return during one execution cycle. |
Other
Make an API Call
Performs an arbitrary authorized API Call.
| Connection | Establish a connection to your Hubstaff account. |
| URL | Enter a path relative to For the list of available endpoints, refer to the Hubstaff Developer Documentation. |
| Method | Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
| Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
| Query String | Enter the request query string. |
| Body | Enter the body content for your API call. |
Example of Use - List Tasks
The following API call returns all the tasks from the specified organizations of your Hubstaff account:
URL:/v2/organizations/organization_id/tasks
Method:GET
Matches of the search can be found in the module's Output under Bundle > Body > tasks.
In our example, 2 tasks were returned:
