Skip to content

Celoxis

The Celoxis modules allow you to watch, create, update, list, retrieve, and delete tasks, users, projects, time entries, and apps in your Celoxis account.

Getting Started with Celoxis

Prerequisites

  • A Celoxis account

In order to use Celoxis with Ibexa Connect, it is necessary to have a Celoxis account. If you do not have one, you can create a Celoxis account at celoxis.com/trial.

Connecting Celoxis to Ibexa Connect

To connect your Celoxis account to Ibexa Connect you need to obtain the Celoxis Webhook URL and API Key from your Celoxis account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Celoxis account.

2. Click your Profile Icon > API > Click here > Generate API Token.

3. Click OK and copy the API Token to your clipboard.

61f268902095d.png

4. Go to Ibexa Connect and open the Celoxis module's Create a connection dialog.

61f26891211c8.gif

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

6. In the API Token field, enter the API token copied in step 4 and click Continue.

The connection has been established.

Tasks

Watch New Task

Watches for newly created tasks.

Limit Set the maximum number of new tasks Ibexa Connect should return during one scenario execution cycle.

Watch Task Update

Watches for newly updated tasks.

Limit Set the maximum number of updated tasks Ibexa Connect should return during one scenario execution cycle.

List Tasks

Returns a list of tasks.

Order

Select the order in which you want to list the tasks:

  • Ascending

  • Descending

Sort By

Select the option to sort the tasks.

Keywords

Enter the keywords or phrases to search the tasks based on the specified criteria.

Name

Enter the name of the task to list the details.

Hierarchy

Enter the hierarchy details to list only those tasks related to it.

Summary Tasks

Select whether to list the summary tasks:

  • Yes

  • No

  • Not defined

Assigned

Select whether to list the assigned tasks:

  • Yes

  • No

  • Not defined

Task Level

Select the task level of the task you want to list.

Display Tasks

Select the option to display the tasks:

  • Starting Today

  • Starting This Week

  • Starting This Month

  • Due Today

  • Due This Week

  • Due This Month

  • In Progress

  • Incomplete

  • Recently Completed

Limit

Set the maximum number of tasks Ibexa Connect should return during one scenario execution cycle.

Get a Task

Returns information about a task.

Task ID Select the Task ID whose details you want to retrieve.

Create a Task

Creates a new task.

Name

Enter the name of the task.

Project ID

Select the Project ID related to the task.

Actual Finish

Enter the date when the task is completed.

Actual Start

Enter the date when the task has begun.

Allow Time Logging

Select whether you want to log the time for the task:

  • Yes

  • No

  • Not defined

Billing Type

Select the billing type of the task:

  • No Billing

  • Fixed Price

  • Time & Material

Budget

Enter the budget amount allocated for the task.

Constraint Date

Enter the priority date by which the task to be completed.

Description

Enter the details of the task.

Duration

Enter the total duration in minutes or hours took to complete the task.

Kanban State

Select the Kanban state of the task:

  • Backlog

  • Done

  • In Progress

Manually Scheduled

Select whether the task is scheduled manually:

  • Yes

  • No

  • Not defined

Planned Effort

Enter the details of the planned effort on the task.

Planned Finish

Enter the date by when the task is planned to complete.

Planned Fixed Cost

Enter the fixed cost planned for the task.

Planned Non Labor Cost

Enter the non-labor cost planned for the task. For example, software.

Planned Start

Enter the date when the task is planned to start.

Priority

Select the priority of the task:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Resource ID

Select the resources to whom the task is assigned:

  • Team Member

  • Executive

  • Sally Peters

Schedule Type

Select the schedule type of the task:

  • Fixed Units

  • Fixed Effort

  • Fixed Duration

Update a Task

Updates information about a task.

Task ID

Select the Task ID whose details you want to update.

Name

Enter the name of the task.

% Complete

Enter the percentage of progress made on the task.

Project ID

Select the Project ID related to the task.

Actual Finish

Enter the date when the task is completed.

Actual Start

Enter the date when the task has begun.

Allow Time Logging

Select whether you want to log the time for the task:

  • Yes

  • No

  • Not defined

Billing Type

Select the billing type of the task:

  • No Billing

  • Fixed Price

  • Time & Material

Budget

Enter the budget amount allocated for the task.

Constraint Date

Enter the priority date by which the task to be completed.

Description

Enter the details of the task.

Duration

Enter the total duration in minutes or hours took to complete the task.

Kanban State

Select the Kanban state of the task:

  • Backlog

  • Done

  • In Progress

Manually Scheduled

Select whether the task is scheduled manually:

  • Yes

  • No

  • Not defined

Planned Effort

Enter the details of the planned effort on the task.

Planned Finish

Enter the date by when the task is planned to complete.

Planned Fixed Cost

Enter the fixed cost planned for the task.

Planned Non Labor Cost

Enter the non-labor cost planned for the task. For example, software.

Planned Start

Enter the date when the task is planned to start.

Priority

Select the priority of the task:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Resource ID

Select the resources to whom the task is assigned:

  • Team Member

  • Executive

  • Sally Peters

Schedule Type

Select the schedule type of the task:

  • Fixed Units

  • Fixed Effort

  • Fixed Duration

Delete a Task

Deletes a task.

Task ID Select the Task ID you want to delete.

Time Entries

List Time Entries

Returns a list of time entries.

Order

Select the order to list the time entries:

  • Ascending

  • Descending

Sort by

Select the option to sort the time entries.

Approver

Select the approver of the time entries you want to list.

Non Project Time

Select whether to list the non-project time entries:

  • Yes

  • No

  • Not defined

Limit

Set the maximum number of time entries Ibexa Connect should return during one scenario execution cycle.

Get a Time Entry

Returns information about a time entry.

Time Entry ID Select the Time Entry ID whose details you want to retrieve.

Create a Time Entry

Creates a new time entry.

Date

Enter the date on which you want to create the time entry.

Hours

Enter the hours in the HH:MM 24 hour format. For example, 04:25.

Time Code

Select the time code for the time entry:

  • Default

  • Vacation

  • Meeting

  • Sick Leave

App ID

Select the App ID related to the time entry.

Task ID

Select the Task ID related to the time entry.

Bill Rate

Enter the billing rate for the time entry.

Cost Rate

Enter the cost rate for the time entry.

Billable

Select whether the time entry is billable:

  • Yes

  • No

  • Not defined

Costable

Select whether the time entry is costable:

  • Yes

  • No

  • Not defined

Comments

Enter any additional comments about the time entry.

Invoiced On

Enter the date when the time entry is invoiced.

User ID

Select the User ID for whom you are creating the time entry.

State

Select the status of the time entry:

  • Saved

  • Pending Approval

  • Rejected

  • Approved

  • Invoiced

Approver ID

Select the Approver ID who is the approver for the time entry.

Invoicer ID

Select the Invoicer ID of the time entry:

  • Team Member

  • Executive

  • Sally Peters

Update a Time Entry

Updates information about a time entry.

Time Entry ID

Select the Time Entry ID whose details you want to update.

Date

Enter the date on which you want to create the time entry.

Hours

Enter the hours in the HH:MM 24 hour format. For example, 04:25

Time Code

Select the time code for the time entry:

  • Default

  • Vacation

  • Meeting

  • Sick Leave

App ID

Select the App ID related to the time entry.

Task ID

Select the Task ID related to the time entry.

Bill Rate

Enter the billing rate for the time entry.

Cost Rate

Enter the cost rate for the time entry.

Billable

Select whether the time entry is billable:

  • Yes

  • No

  • Not defined

Costable

Select whether the time entry is costable:

  • Yes

  • No

  • Not defined

Comments

Enter any additional comments about the time entry.

Invoiced On

Enter the date when the time entry is invoiced.

User ID

Select the User ID for whom you are creating the time entry.

State

Select the status of the time entry:

  • Saved

  • Pending Approval

  • Rejected

  • Approved

  • Invoiced

Approver ID

Select the Approver ID who is the approver for the time entry.

Invoicer ID

Select the Invoicer ID of the time entry:

  • Team Member

  • Executive

  • Sally Peters

Delete a Time Entry

Deletes a specified time log.

Time Entry ID Select the Time Entry ID you want to delete.

Users

List Users

Returns a list of users.

Order

Select the order to list the users:

  • Ascending

  • Descending

Sort By

Select the option to sort the users.

Search

Enter a keyword or phrase to search the users based on the specified criteria.

Job Role

Select whether to list the job role of the users:

  • Yes

  • No

  • Not defined

Active

Select whether to list active users:

  • Yes

  • No

  • Not defined

Limit

Set the maximum number of users Ibexa Connect should return during one scenario execution cycle.

Get a User

Returns information about a user.

User ID Select the User ID whose details you want to retrieve.

Create a User

Creates a new user.

Name

Enter the name of the user.

Non Virtual

Select the checkbox if the user is non-virtual.

Admin

Select whether the user is an admin:

  • Yes

  • No

  • Not defined

Phone

Enter the phone number of the user.

Role

Select the role of the user:

  • Accountant

  • Executive

  • External Users

  • Project Creator

  • Staff

Dashboard

Select the appropriate dashboard for the user.

Reporting Manager ID

Select the Reporting Manager ID to whom the user must report to.

Locale

Enter the applicable language for the user. For example, en_US, fi_FI.

Bill Rate

Enter the billing rate of the user.

Cost Rate

Enter the cost rate of the user.

Update a User

Updates information about a user.

User ID

Select the User ID whose details you want to update.

Name

Enter the name of the user.

Non Virtual

Select whether the user is non-virtual:

  • Yes

  • No

  • Not defined

Admin

Select whether the user is an admin:

  • Yes

  • No

  • Not defined

Phone

Enter the phone number of the user.

Role

Select the role of the user:

  • Accountant

  • Executive

  • External Users

  • Project Creator

  • Staff

Dashboard

Select the appropriate dashboard for the user.

Reporting Manager ID

Select the Reporting Manager ID to whom the user must report to.

Locale

Enter the applicable language for the user. For example, en_US, fi_FI.

Bill Rate

Enter the billing rate of the user.

Cost Rate

Enter the cost rate of the user.

Projects

List Projects

Returns a list of projects.

Order

Select the order in which you want to list the projects:

  • Ascending

  • Descending

Sort By

Select the option to sort the projects.

Keywords

Enter the keywords or phrases to search the projects based on the specified criteria.

Name

Enter the name of the project to list the details.

Open Projects

Enter the open project details to list only those projects.

Team

Enter the team details to list the project related to only those teams.

Limit

Set the maximum number of projects Ibexa Connect should return during one scenario execution cycle.

Get a Project

Returns information about a project.

Project ID Select the Project ID whose details you want to list.

Create a Project

Creates a new project.

Manager ID

Select the Manager ID who will manage the project.

Name

Enter a name for the project.

Planned Start

Enter the date when the project begins.

State

Select the state of the project:

  • Draft

  • Active

  • On Hold

  • Completed

  • Canceled

Type

Select the project type:

  • Infrastructure

  • Implementation

Alignment

Enter a number 0 and 100 based on how closely the project's requirements match with the organization's business, goals, skill sets, and resources. A higher number means better alignment.

Benefit

Enter a number between 0 and 100 based on how closely the project reflects the potential for financial or operational gain upon successful completion. A higher number means more benefits.

Client ID

Select the Client ID associated with the project.

Billing Type

Select the billing type of the project:

  • No Billing

  • Fixed Price

  • Time & Material

Budget

Enter the amount allocated for the project.

Code

Enter the

Deadline

Enter the date when the project must be completed.

Description

Enter the details of the project.

Fixed Price

Enter the price fixed for the project.

Priority

Select the priority of the project:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Risk

Select the Risk type of the project:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Update a Project

Updates information about a project.

Project ID

Select the Project ID whose details you want to update.

Manager ID

Select the Manager ID who will manage the project.

Name

Enter a name for the project.

Planned Start

Enter the date when the project begins.

State

Select the state of the project:

  • Draft

  • Active

  • On Hold

  • Completed

  • Canceled

Type

Select the project type:

  • Infrastructure

  • Implementation

Alignment

Enter a number 0 and 100 based on how closely the project's requirements match with the organization's business, goals, skill sets, and resources. A higher number means better alignment.

Benefit

Enter a number between 0 and 100 based on how closely the project reflects the potential for financial or operational gain upon successful completion. A higher number means more benefits.

Client ID

Select the Client ID associated with the project.

Billing Type

Select the billing type of the project:

  • No Billing

  • Fixed Price

  • Time & Material

Budget

Enter the amount allocated for the project.

Code

Enter the

Deadline

Enter the date when the project must be completed.

Description

Enter the details of the project.

Fixed Price

Enter the price fixed for the project.

Priority

Select the priority of the project:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Risk

Select the Risk type of the project:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Delete a Project

Deletes a project.

Project ID Select the Project ID you want to delete.

Apps

List Apps

Returns a list of apps.

Order

Select the order in which you want to list the apps:

  • Ascending

  • Descending

Sort By

Select the option to sort the apps.

Keywords

Enter the keywords or phrases to search the apps based on the specified criteria.

State

Enter the name of the task to list the details.

Limit

Set the maximum number of apps Ibexa Connect should return during one scenario execution cycle.

Get an App

Returns information about an app.

App ID Select the App ID whose details you want to retrieve.

Create an App

Creates a new app.

Project ID

Select the Project ID to which you are creating the app.

App

Select the app type:

  • Project Request

  • Risk

  • Issue

  • Change Request

  • Bug

  • Status Request

Name

Enter a name for the app.

Date

Enter the date when you are creating the app.

Description

Enter the details of the app.

Due Date

Enter the date when the app must be completed.

Mitigation Plan

Enter the details of the mitigation plan for the app.

Mitigation Cost

Enter the mitigation cost details of the project.

Potential Cost

Enter the cost planned if the risk occurs.

Bug Type

If the app is a bug, select the bug type:

  • Bug

  • Improvement

  • New Feature

Component

Select the app component.

Fix Version

Select the software product fix version of the app.

Affects Version

Select the version the app fix affects.

Budget

Select the color code for the app budget. For example, Green, Yellow.

Issue

Select the color code for the app issue. For example, Green, Yellow.

Overall

Select the overall status of the app.

Quality

Select the quality of the app.

Schedule

Select the schedule status of the app.

Scope

Select the scope of the app.

Team

Select the team to whom the app is assigned.

Risk

Select the risk status of the app.

Risk Impact

Select the risk impact of the app.

Risk Probability

Select the risk probability of the app:

  • Almost certain

  • Likely

  • Possible

  • Rare

  • Unlikely

Priority

Select the priority of the app:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Severity

Select the severity of the app:

  • Major

  • Minor

Resolution

Select the resolution for the app:

  • Cannot Reproduce

  • Duplicate

  • Fixed

  • Incomplete

  • Not a Bug

  • Won't Fix

Update an App

Updates information about an app.

App ID

Select the App ID whose details you want to update.

Project ID

Select the Project ID to which you are creating the app.

App

Select the app type:

  • Project Request

  • Risk

  • Issue

  • Change Request

  • Bug

  • Status Request

Name

Enter a name for the app.

Date

Enter the date when you are creating the app.

Description

Enter the details of the app.

Due Date

Enter the date when the app must be completed.

Mitigation Plan

Enter the details of the mitigation plan for the app.

Mitigation Cost

Enter the mitigation cost details of the project.

Potential Cost

Enter the cost planned if the risk occurs.

Bug Type

If the app is a bug, select the bug type:

  • Bug

  • Improvement

  • New Feature

Component

Select the app component.

Fix Version

Select the software product fix version of the app.

Affects Version

Select the version the app fix affects.

Budget

Select the color code for the app budget. For example, Green, Yellow.

Issue

Select the color code for the app issue. For example, Green, Yellow.

Overall

Select the overall status of the app.

Quality

Select the quality of the app.

Schedule

Select the schedule status of the app.

Scope

Select the scope of the app.

Team

Select the team to whom the app is assigned.

Risk

Select the risk status of the app.

Risk Impact

Select the risk impact of the app.

Risk Probability

Select the risk probability of the app:

  • Almost certain

  • Likely

  • Possible

  • Rare

  • Unlikely

Priority

Select the priority of the app:

  • Very High

  • High

  • Normal

  • Low

  • Very Low

Severity

Select the severity of the app:

  • Major

  • Minor

Resolution

Select the resolution of the app:

  • Cannot Reproduce

  • Duplicate

  • Fixed

  • Incomplete

  • Not a Bug

  • Won't Fix

Delete an App

Deletes specified app.

App ID Select the App ID you want to delete.

Others

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.celoxis.com/psa/api. For example: /v2/timeEntries

For the list of available endpoints, refer to the Celoxis API 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 Projects

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

URL:

/v2/projects

Method:

GET

You can get the task ID, Project ID, user ID, Time Entry ID, App ID details from their respective list modules.

61f2689340ac5.png

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

In our example, 3 projects were returned:

61f2689440f64.png