• Documentation >
• Apps >
• Productivity >
• awork

awork

With the awork modules in Ibexa Connect, you can:

• create, update, retrieve and delete the companies

• create, update, retrieve and delete the projects

• watch, create, update, retrieve and delete the tasks

• watch, retrieve, create, update and delete the time entries

To get started with awork, create an account at .awork.io

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connect awork with Ibexa Connect

To connect the awork app with the Ibexa Connect:

1. Log in to your awork account.

2. Click Settings > Integrations.

   

3. Navigate to API access and click the Plus icon to add a client.

   

4. Enter the details as mentioned below and click Save.

   

   • Name: Enter a name for the app.

   • Client ID: Enter the Client ID in the my-app format.

   • Add redirect URI: Enter the redirect URI as https://www.make.com/oauth/cb/awork or https://www.integromat.com/oauth/cb/awork. Click the Plus icon to add more redirect URIs.

5. Copy the Client Secret to a safe place.

   

6. Log in to your Ibexa Connect and add an awork module from Ibexa Connect into a scenario.

7. Click Add next to the Connection field.

   

8. In the Connection name field, enter a name for the connection.

9. In the Client ID and Client Secret fields, enter the details copied in steps 3 and 4 respectively, and click Save.

10. Click Yes to authorize the Ibexa Connect to access your work account.

    

11. Select your workspace to continue.

    

You have successfully connected the awork app with Ibexa Connect and can now build scenarios.

Company

You can create, update, retrieve and delete the company using the following modules.

Get a Company

Returns information about the chosen company.

Company	Select or map a company whose details you want to retrieve.

Create a Company

Creates a new company.

Name	Enter (map) a name for the company.
Description	Enter (map) the company details.
Industry	Enter (map) the industry in which the company does business.

Update a Company

Updates information about the chosen company.

Company	Select or map a company whose details you want to update.
Name	Enter (map) a new name for the company.
Description	Enter (map) the company details.
Industry	Enter (map) the industry in which the company does business.

Delete a Company

Deletes a chosen company.

Company	Select or map the company you want to delete.
Delete operation	Select the operation you want to delete: Move related objects to another company Delete only the company. Related objects lose the company information. Delete all related objects apart from time entries. Delete all.
Company	Select or map the company to which you want to move this company's related objects.

Project

You can create, update, retrieve, and delete the project using the following modules.

Get a Project

Returns information about the chosen project.

Project	Select or map a project whose details you want to retrieve.

Create a Project

Creates a new project.

Name	Enter (map) a name for the project.
Project type	Select or map the project type.
Description	Enter (map) the project details.
Start date	Enter (map) the start date of the project. See the list of supported date and time formats.
Due date	Enter (map) the due date of the project. See the list of supported date and time formats.
Company	Select or map a company associated with the project.

Update a Project

Updates information about the chosen project.

Project	Select or map a project whose details you want to update.
Name	Enter (map) a new name for the project.
Project type	Select or map the project type.
Project status	Select the project status. For example, canceled.
Description	Enter (map) the project details.
Start date	Enter (map) the start date of the project. See the list of supported date and time formats.
Due date	Enter (map) the due date of the project. See the list of supported date and time formats.
Company	Select or map the company associated with the project.

Delete a Project

Deletes a chosen project.

Project	Select or map the project you want to delete.
Delete Time Trackings	Select whether to delete the time tracking related to the project.

Task

You can watch, create, update, retrieve and delete the task using the following modules.

Watch Tasks

Triggers when a new task is created.

Limit	Set the maximum number of tasks Ibexa Connect will return during one execution cycle. The default value is 2.

Get a Task

Returns information about the chosen task.

Project	Select or map a project whose tasks you want to retrieve.
Task	Select or map a task to retrieve.

Create a Task

Creates a new task.

Name	Enter (map) a name for the task.
Type of Work	Select the work type. For example, Internal work.
Project	Select or map a project for which you want to create the task.
Task Status	Select the task status. For example, in progress.
Order	Enter (map) the order of the task in the task status column.
Planned Duration	Enter (map) the expected planned workload of the task in seconds.
Remaining Duration	Enter (map) the expected remaining duration from the originally planned effort of the task in seconds.
Description	Enter (map) the task details.
Is Prio	Select whether this task is marked as a priority.
Start On	Enter (map) a date to start the task. See the list of supported date and time formats.
Due On	Enter (map) the due date for the task. See the list of supported date and time formats.
Lane Order	Enter (map) the lane order to define the vertical position in the gantt planner.

Update a Task

Updates a chosen task.

Project	Select or map a project whose task details you want to update.
Task	Select or map a task whose details you want to update.
Name	Enter (map) a new name for the task.
Planned Duration	Enter (map) the expected planned workload of the task in seconds.
Remaining Duration	Enter (map) the expected remaining duration from the originally planned effort of the task, in seconds.
Description	Enter (map) the task details.
Is Prio	Select whether this task is marked as a priority.
Start On	Enter (map) a date to start the task. See the list of supported date and time formats.
Due On	Enter (map) the due date for the task. See the list of supported date and time formats.
Lane Order	Enter (map) the lane order to define the vertical position in the gantt planner.

Delete a Task

Deletes the specified tasks.

Tasks	Enter (map) the task details to delete: Project ID Select or map a Project ID whose task you want to delete. Task ID Select or map a Task ID you want to delete.
Delete Time Trackings	Select whether to delete the related time tracking details of the task.

Time Entry

You can watch, retrieve, create, update and delete the time entry using the following modules.

Watch Time Entries

Triggers when a new time entry is created.

Limit	Set the maximum number of time entries Ibexa Connect should return during one execution cycle. The default value is 2.

Get a Time Entry

Returns information about chosen time entry.

Time Entry	Select or map a time entry whose details you want to retrieve.

Create a Time Entry

Creates a new time entry.

Start Date	Enter (map) the start date for the time entry. See the list of supported date and time formats.
Type Of Work	Select the work type. For example, internal work.
User	Select or map a user whose time entry you want to create.
Timezone	Select or map a timezone of the user.
Duration	Enter (map) the duration of the time tracking in seconds. You need to enter either start time and end time or duration.
Start Time	Enter (map) the start time for the time entry. See the list of supported date and time formats.
End Time	Enter (map) the end time of the time entry. See the list of supported date and time formats.
Is Billable	Select whether the time entry is billable.
Is Billed	Select whether the time entry is billed.
Project	Select or map a project whose task's time entry you want to create.
Task	Select or map a task for which you want to create the time entry.
Note	Enter (map) the details of the time entry.
Location	Enter (map) the location by entering the latitude and longitude details.

Update a Time Entry

Updates a chosen time entry.

Time Entry	Select or map a time entry whose details you want to update.
Start Date	Enter (map) the start date for the time entry. See the list of supported date and time formats.
Start Time	Enter (map) the start time for the time entry. See the list of supported date and time formats.
End Time	Enter (map) the end time of the time entry. See the list of supported date and time formats.
Type Of Work	Select the work type. For example, internal work.
User	Select or map a user whose time entry you want to create.
Timezone	Select or map the user timezone.
Duration	Enter (map) the duration of the time tracking in seconds. You need to enter either start time and end time or duration.
Is Billable	Select whether the time entry is billable.
Is Billed	Select whether the time entry is billed.
Project	Select or map a project whose task's time entry you want to create.
Task	Select or map a task for which you want to create the time entry.
Note	Enter (map) details of the time entry.
Location	Enter (map) the location by entering the longitude and latitude details.

Delete a Time Entry

Deletes a chosen time entry.

Time Entries	Select or map a time entry you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.awork.io/api. For example, /v1/me.

For the list of available endpoints, refer to the awork API documentation.

Method

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 Projects

The following API call returns all the projects from your awork account:

URL:

/v2/projects

Method:

GET

Matches of the search can be found in the module's Output under Bundles > Body.

In our example, 5 projects were returned: