• Documentation >
• Apps >
• Productivity >
• Hubstaff

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/.

Connecting Hubstaff to Ibexa Connect

1. Log in to your Ibexa Connect account, add a module from the Canvas LMS app into an Ibexa Connect 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.

Limit	Set the maximum number of results Ibexa Connect should return during one execution cycle.

Invites

List Invites

Retrieves a list of invites.

Organization ID	Select or map the Organization ID whose invites you want to list.
Email	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. Pending All Accepted Expired
Limit	Set the maximum number of results Ibexa Connect should return during one execution cycle.

Get an Invite

Retrieves a specific invite.

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.

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. Project User Organization Manager Project Manager Project Viewer
Pay Rate	Enter (map) the pay rate of the user.

Update a Pending Invite

Updates a pending invite.

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: Project User Organization Manager Project Manager Project Viewer
Pay Rate	Enter (map) the pay rate for the user.

Delete an Invite

Deletes a specific invite.

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.

Organization ID	Select or map the Organization ID whose projects you want to watch.
Limit	Set the maximum number of projects Ibexa Connect should return during one execution cycle.

List Projects

Retrieves a list of projects.

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. Active Archived All
Limit	Set the maximum number of projects Ibexa Connect should return during one execution cycle.

Get a Project

Retrieves a specific project.

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.

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 IDSelect or map the member's Organization ID.RoleSelect the member's role: Viewer User Manager
Budget	Select or map the budget type: Cost Hours
Cost	Add the cost details of the project: Rate Select or map the rate type: Bill Rate Pay Rate Cost Limit Enter (map) the cost limit. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.
Hours	Add the hour's details of the project: Hours Limit Enter (map) the hours approved for this project. Start Date Enter (map) the start date of the project. See the list of supported date and time formats. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.

Update a Project

Updates a specific project.

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: Active Archived
Budget	Select or map the budget type: Cost Hours
Cost	Update the cost details of the project: Rate Select or map the rate type: Bill Rate Pay Rate Cost Limit Enter (map) the cost limit allocated for the project. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.
Hours	Update the hour's details of the project: Hours Limit Enter (map) the hours approved for this project. Start Date Enter (map) the start date of the project. See the list of supported date and time formats. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.

Tasks

Watch Tasks Created

Triggers if new tasks have been created.

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 Ibexa Connect should return during one execution cycle.

Watch Tasks Completed

Triggers if some tasks have been completed.

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 Ibexa Connect should return during one execution cycle.

List Tasks

Retrieves a list of tasks.

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 Ibexa Connect should return during one execution cycle.

Get a Task

Retrieves a specific task.

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.

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.

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: Active Completed

Delete a Task

Deletes a specific task.

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.

Organization ID	Select or map the Organization ID whose clients you want to watch.
Limit	Set the maximum number of clients Ibexa Connect should return during one execution cycle.

List Clients

Retrieves a list of clients.

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. Active Archived All
Limit	Set the maximum number of clients Ibexa Connect should return during one execution cycle.

Get a Client

Retrieves a new client.

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.

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 Hours
Cost	Add the cost details of the client: Rate Select or map the rate type: Bill Rate Pay Rate Cost Limit Enter (map) the cost limit allocated for the project. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.
Hours	Add the hour's details of the client: Hours Limit Enter (map) the hours approved for this project. Start Date Enter (map) the start date of the project. See the list of supported date and time formats. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.

Update a Client

Updates a certain client.

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 Hours
Cost	Add the cost details of the client: Rate Select or map the rate type: Bill Rate Pay Rate Cost Limit Enter (map) the cost limit allocated for the project. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.
Hours	Add the hour's details of the client: Hours Limit Enter (map) the hours approved for this project. Start Date Enter (map) the start date of the project. See the list of supported date and time formats. Recurrence Select or map the recurrence type: Monthly Never Include Non-Billable Select whether the project is non-billable.

Team Invoices

List Team Invoices

Retrieves a list of team invoices.

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: Closed Draft Open
Include Line Items	Select whether to include the line items in the invoice.
Limit	Set the maximum number of invoices Ibexa Connect should return during one execution cycle.

Client Invoices

List Client Invoices

Retrieves a list of client invoices.

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: Closed Draft Open
Include Line Items	Select whether to include the line items in the invoice.
Limit	Set the maximum number of invoices Ibexa Connect should return during one execution cycle.

Attendance Schedules

Watch Schedules Created

Triggers if new schedules have been created.

Organization ID	Select or map the Organization ID whose schedules you want to watch.
Limit	Set the maximum number of schedules Ibexa Connect should return during one execution cycle.

Watch Schedules Updated

Triggers if schedules have been updated.

Organization ID	Select or map the Organization ID whose updated schedules you want to watch.
Limit	Set the maximum number of schedules Ibexa Connect should return during one execution cycle.

Attendance Shifts

Watch Early Shifts

Triggers if shifts have become early.

Organization ID	Select or map the Organization ID whose early shifts you want to watch.
Limit	Set the maximum number of early shifts Ibexa Connect should return during one execution cycle.

Watch Missed Shifts

Triggers if shifts have been missed.

Organization ID	Select or map the Organization ID whose missed shifts you want to watch.
Limit	Set the maximum number of missed shifts Ibexa Connect should return during one execution cycle.

Watch Late Shifts

Triggers if shifts have been late.

Organization ID	Select or map the Organization ID whose late shifts you want to watch.
Limit	Set the maximum number of late shifts Ibexa Connect should return during one execution cycle.

Other

Make an API Call

Performs an arbitrary authorized API Call.

URL	Enter a path relative to https://api.hubstaff.com For example: /v2/organizations For the list of available endpoints, refer to the Hubstaff Developer Documentation.
Method	Select the HTTP method you want to use:GETto retrieve information for an entry.POSTto create a new entry.PUTto update/replace an existing entry.PATCHto make a partial entry update.DELETEto 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:

old bold"> Method

Select the HTTP method you want to use:GETto retrieve information for an entry.POSTto create a new entry.PUTto update/replace an existing entry.PATCHto make a partial entry update.DELETEto 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: