Skip to content
  • Documentation >
  • Apps >
  • Productivity >
  • ProjectWorks

ProjectWorks

With ProjectWorks modules in Ibexa Connect, you can:

  • search, retrieve, create, and update users

  • list, retrieve, update and delete timesheets

  • list, retrieve, create, replace, and delete leaves

  • list and create the forecast

  • list, retrieve, create, update, and delete clients

To get started with ProjectWorks, create an account at projectworks.io.

Connect ProjectWorks to Ibexa Connect

To connect ProjectWorks app, you need to obtain the Consumer key and Consumer secret.

  1. Log in to your ProjectWorks account.

  2. Click Profile icon > Admin.

    ProjectWorks_2.png

  3. Click API Accounts.

    ProjectWorks_3.png

  4. Click Three Dots > Details.

    ProjectWorks_4.png

  5. Copy the Consumer key and Consumer secret to a safe place.

    ProjectWorks_5.png

  6. Log in to your Ibexa Connect account, insert a ProjectWorks module, and click the Add button next to the Connection field.

    ProjectWorks_1.gif

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

  8. In the Username and Password fields, enter the Consumer key and Consumer secret copied in step 5 and click Save.

You have successfully connected the ProjectWorks app and can now build scenarios.

Users

You can search, retrieve, create, and update users using the following modules.

Search Users

Searches for users.
Limit Set the maximum number of users Ibexa Connect will return during one execution cycle.

See ProjectWorks API reference for entering the field values to search the users that match the specified value.

Get a User

Returns information about the selected user.
User ID Select or map the User ID whose details you want to retrieve.

Create a User

Create a new user.

For field descriptions, see the ProjectWorks API reference.

Update a User

Updates the selected user.
User ID Select or map the User ID whose details you want to update.

For field descriptions, see the ProjectWorks API reference.

Timesheets

You can list, retrieve, update and delete timesheets using the following modules.

List Timesheets

Lists all timesheets.
Limit Set the maximum number of timesheets Ibexa Connect will return during one execution cycle.

See ProjectWorks API reference for entering the field values to list the users that match the specified value.

Get a Timesheet

Returns information about the selected timesheet.
Timesheet ID Select or map the Timesheet ID whose details you want to retrieve.

Update a Timesheet

Replaces a timesheet entry.
Timesheet ID Select or map the Timesheet ID whose details you want to update.

For field descriptions, see the ProjectWorks API reference.

Delete a Timesheet

Deletes the selected timesheet.
Timesheet ID Select or map the Timesheet ID you want to delete.

Leaves

You can list, retrieve, create, replace, and delete leaves using the following modules.

List Leaves

Lists all leaves.
Limit Set the maximum number of leaves Ibexa Connect will return during one execution cycle.

See ProjectWorks API reference for entering the field values to list the leaves that match the specified value.

Get a Leave

Returns information about the selected leave.
Leave ID Select or map the Leave ID whose details you want to retrieve.

Create a Leave

Creates a new leave.

For field descriptions, see the ProjectWorks API reference.

Replace a Leave

Replaces the selected leave.
Leave ID Select or map the Leave ID whose details you want to update.

For field descriptions, see the ProjectWorks API reference.

Delete a Leave

Deletes the selected leave.
Leave ID Select or map the Leave ID you want to delete.

Forecasts

You can list and create forecasts using the following modules.

List Forecasts

Lists all forecasts.
Limit Set the maximum number of users Ibexa Connect will return during one execution cycle.

See ProjectWorks API reference for entering the field values to list the forecasts that match the specified value.

Create a Forecast

Creates a new forecast.

For field descriptions, see the ProjectWorks API reference.

Clients

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

List Clients

Lists all clients.
Limit Set the maximum number of clients Ibexa Connect will return during one execution cycle.

See ProjectWorks API reference for entering the field values to list the clients that match the specified value.

Get a Client

Returns information about the selected client.
Client ID Select or map the Client ID whose details you want to retrieve.

Create a Client

Creates a new client.

For field descriptions, see the ProjectWorks API reference.

Update a Client

Updates the selected client.
Client ID Select or map the Client ID whose details you want to update.

For field descriptions, see the ProjectWorks API reference.

Delete a Client

Deletes the selected client.
Client ID Select or map the Client ID you want to delete.

Other

You can call APIs using the following module.

Note

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

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.projectworksapp.com/api. For example, /v1.0/Clients.

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 Leaves

The following API call returns all leaves from your account.

URL: /v1.0/Leaves

Method: GET

ProjectWorks_6.png

The search matches can be found in the module's Output under Bundle > Body.

In our example, 6 leaves were returned:

ProjectWorks_7.png