• Documentation >
• Apps >
• Productivity >
• TimeCamp

TimeCamp

Getting Started with TimeCamp

The TimeCamp modules allow you to watch, create, update, list, and delete the projects, tasks, and time entries in your TimeCamp account.

Prerequisites

• A TimeCamp account

In order to use TimeCamp with Ibexa Connect, it is necessary to have a TimeCamp account. If you do not have one, you can user your Google account or create a TimeCamp account at timecamp.com/register.

Connecting TimeCamp to Ibexa Connect

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

1. Log in to your TimeCamp account and open your Dashboard.

2. Click you Profile Icon > Your Email Address and scroll down to locate Your Programming API Token.

3. Copy the API token to your clipboard.

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

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

6. In the API Key field, enter the API key copied in step 4 and click Continue.

The connection has been established.

Projects

Create a Project

Creates a new project.

Project Name	Enter a name for the project.
Tags	Enter the keywords that can be used to filter the projects when searching.
External Task ID	Enter the External Task ID related to this project.
External Parent ID	Enter the External Parent ID if this project is part of any other major project.
Budgeted	Enter the number of hours allocated for this project.
Note	Enter the details or any additional information for the project.
Archived	Select whether this project is archived: Yes No Not defined
User IDs	Add the comma-separated User IDs to whom the task is assigned.
Role	Select the role of the user.

Delete a Project

Deletes an existing project.

Project ID	Select the Project ID you want to delete.

Update a Project

Updates an existing task.

Task ID	Select the Task ID whose project you want to update.
Project Name	Enter a name for the project.
Tags	Enter the keywords that can be used to filter the projects when searching.
External Task ID	Enter the External Task ID related to this project.
External Parent ID	Enter the External Parent ID if this project is part of any other major project.
Budgeted	Enter the number of hours allocated for this project.
Note	Enter the details or any additional information for the project.
Archived	Select whether this project is archived: Yes No Not defined
Billable	Select whether this project is billable: Yes No Not defined
Budget Unit	Enter the amount billable per hour.
User IDs	Add the comma-separated User IDs to whom the task is assigned.
Role	Select the role of the user.

Watch Projects

Triggers when a new project is created.

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

Get a Project

Gets a project's information.

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

Note

If the account has no projects to return, you will receive an error, [403] "You do not have permissions to get the task details".

List Projects

List all projects.

Run archived tasks only	Select whether you want to list only the archived task projects: Yes No Not defined
Limit	Enter the maximum number of projects Ibexa Connect should return during one scenario execution cycle.

Tasks

Create a Task

Creates a new task.

Task Name	Enter a name for the task.
Project ID	Select the Project ID for which the task is being created for.
Tags	Enter the keywords that can be used to filter the task when searching.
External Task ID	Enter the External Task ID related to this task.
External Parent ID	Enter the External Parent ID if this task is part of any other major project.
Budgeted	Enter the number of hours allocated for this task.
Note	Enter the details or any additional information for the task.
Archived	Select whether this task is archived: Yes No Not defined
Billable	Select whether this task is billable: Yes No Not defined
Budget Unit	Enter the amount billable per hour.
User IDs	Add the comma-separated User IDs to whom the task is assigned.
Role	Select the role of the user.

Update a Task

Updates an existing task.

Task ID	Select the Task ID you want to update.
Project ID	Select the Project ID associated with the task.
Task Name	Enter a new name for the task.
Tags	Enter the keywords that can be used to filter the task when searching.
External Task ID	Enter the External Task ID related to this task.
External Parent ID	Enter the External Parent ID if this task is part of any other major project.
Budgeted	Enter the number of hours allocated for this task.
Note	Enter the details or any additional information for the task.
Archived	Select whether this task is archived: Yes No Not defined
Billable	Select whether this task is billable: Yes No Not defined
Budget Unit	Enter the amount billable per hour.
User IDs	Add the comma-separated User IDs to whom the task is assigned.
Role	Select the role of the user.

Note

If there is no Task ID exists to update the details, you will receive an error message, [404] null response.

List Tasks

Lists all tasks.

Run archived tasks only	Select whether you want to list only the archived tasks: Yes No Not defined
Limit	Enter the maximum number of tasks Ibexa Connect should return during one scenario execution cycle.

Delete a Task

Deletes an existing task.

Task ID	Select the Task ID you want to delete.

Watch Tasks

Triggers when a new task is created.

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

Get a Task

Gets the task's information.

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

Time Entries

List Time Entries

Gets time entry information.

From Date	Enter the date to list the time entries created or updated on or after the specified date.
To Date	Enter the date to list the time entries created or updated on or before the specified date.
Task IDs	Enter the comma-separated Task IDs whose time entries you want to lis
Limit	Enter the maximum number of time entries Ibexa Connect should return during one scenario execution cycle.

Update a Time Entry

Updates an existing time entry.

Date	Enter the date for which you are creating the time entry.
Duration	Enter the duration of the time entry in seconds.
Note	Enter any additional information about the time entry.
Billable	Select whether the time entry is billable: Yes No Not defined
Start Time	Enter the start time of the time entry in HH:MM format.
End Time	Enter the end time of the time entry in HH:MM format.
Task ID	Select the Task ID associated with the time entry.
Invoice ID	Enter the Invoice ID associated with the time entry.
Update Activities	Select whether you want to update the activities: Yes No Not defined

Create a Time Entry

Creates a new time entry.

Time Entry ID	Enter the Time Entry ID you want to update. You can get the Time Entry IDs using the List Time Entries module.
Duration	Enter the duration of the time entry in seconds.
Note	Enter any additional information for updating the time entry.
Billable	Select whether the time entry is billable: Yes No Not defined
Start Time	Enter the start time of the time entry in HH:MM format.
End Time	Enter the end time of the time entry in HH:MM format.
Task ID	Select the Task ID associated with the time entry.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL	Enter a path relative to https://timecamp.com/thrid_party/api. For example: /tasks For the list of available endpoints, refer to the TimeCamp API Documentation.
Method	Select the HTTP method you want to use: GETt o 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 your TimeCamp account:

URL:/tasks

Method:GET

Matches of the search can be found in the module's Output under Bundle > Body > xml > item. In our example, 3 tasks were returned: