• Documentation >
• Apps >
• Productivity >
• Mavenlink

Mavenlink

The Mavenlink modules enable you to monitor, list, retrieve, create and update projects, tasks and time entries in your Mavenlink account.

Getting Started with Mavenlink

Prerequisites

• A Mavenlink account

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

Connecting Mavenlink to Ibexa Connect

To connect your Mavenlink account to Ibexa Connect follow the general instructions for Connecting to services.

After you click the Continue button, Ibexa Connect will redirect you to the Mavenlink website where you will be prompted to grant Ibexa Connect access to your account.

Confirm the dialog by clicking the Authorize button.

Project

Watch Projects

Retrieves project details when a project is created or updated.

Watch Projects	Select whether you want to watch created or updated projects. By creation time By update time
Search	Searches through title, description, and team lead names. When using the project search, most filters are not available. Only Include archived filter can be used together with the search function.
Filter	Filter returned project by the following filters: Name Filter description Include archived Returns all projects, including archived projects. Can create line items The current user has permission to log time to the project. Budgeted Returns budgeted projects. Participant The specified user is an active participant in the project. Maven participant The specified user is participating as a maven in the project. Non-participant The specified user is not participating in the project.
Limit	Set the maximum number of projects Ibexa Connect will return during one execution cycle.

List Projects

Retrieves projects from your Mavenlink account by the specified filter.

Search	Searches through title, description, and team lead names. When using project search, most filters are not available. Only Include archived filter can be used together with the search function.
Filter	Filter returned project by the following filters: Name Filter description Include archived Returns all projects, including archived projects. Can create line items The current user has permission to log time to the project. Budgeted Returns budgeted projects. Participant The specified user is an active participant in the project. Maven participant The specified user is participating as a maven in the project. Non-participant The specified user is not participating in the project.
Limit	Set the maximum number of projects Ibexa Connect will return during one execution cycle.

Get a Project

Retrieves project details.

Project ID	Select or enter (map) the ID of the project you want to retrieve details about.

Create a Project

Creates a new project.

Title	Enter the title of the new project.
Creator Role	Your role in the new project, either Maven (consultant role) or Buyer (client role).
Consultant Role Name	Enter the consultant label for the project.
Client role name	Enter the client label for the project.
Access Level	Select whether or not the project is open and who it is open to. The options can only be set by project administrators
Description	Enter the description for the project.
Budgeted	Select whether or not the new project should have budget features; defaults to YES option for Mavenlink Pro users and NO option for Free users.
Start Date	Enter the start date for the new project in the YYYY-MM-DD format.
Due Date	Enter the due date for the new project in the YYYY-MM-DD format.
Project Template ID	Select or map the ID of any project template you have created or is being shared with you.
Change Orders	Select the YES option to allow change orders in the new project.
Expenses in Burn Rate	Any expenses (and additional items in invoices) created in the project will count against the budget used in the project's burn rate calculation.

Update a Project

Edit an existing project.

Project ID	Select or map the project you want to update.
Title	Enter the title of the new project.
Creator Role	Your role in the new project, either Maven (consultant role) or Buyer (client role).
Consultant Role Name	Enter the consultant label for the project.
Client role name	Enter the client label for the project.
Access Level	Select whether or not this project is open and who it is open to. The options can only be set by project administrators
Description	Enter the description for the project.
Budgeted	Select whether or not the new project should have budget features; defaults to YES option for Mavenlink Pro users and NO option for Free users.
Start Date	Enter the start date for the new project in the YYYY-MM-DD format.
Due Date	Enter the due date for the new project in the YYYY-MM-DD format.
Expenses in Burn Rate	Any expenses (and additional items in invoices) created in the project will count against the budget used in the project's burn rate calculation.
Posts require privacy decision	It determines who can see communications.
Stories are fixed fee by default	Select to determine the form of billing.
** Tasks default non billable **	Select YES to set tasks as non-billable by default.
** Archived **	Select YES to archive the project.

Task

Watch Tasks

Retrieves task details when a project is created or updated.

Watch Tasks	Select whether you want to watch created or updated tasks. By creation time By update time
Search	Searches through: Title Project Title Description State Assignee Names Tags When using task search, only the following filters are available. Show archived Assigned to current user Uncompleted Starting between Due between Active between All on account
All on Account	Enable this option to retrieve all stories on an account. You can use this field, only if you are a reports viewer or admin.
Filter	Filter returned tasks by the following filters: Name Filter description Show archived Includes archived tasks. Show deleted Includes stories with the deleted_at timestamp. Show from archived projects Select YES to include tasks from Projects that are archived. Story Type Select the task type you want to filter. Sub-tasks not included Enable this option to return parent tasks only. Assigned to current user Select YES to return only stories that are assigned to the current user. Uncompleted Returns uncompleted tasks only. With start or due date Returns only stories that have either a valid start_date or, due_date or both. Without past completed Excludes tasks that have the state as completed and have a due date before today Project ID Returns tasks from the selected project only.
Limit	Set the maximum number of tasks Ibexa Connect will return during one execution cycle.

List Tasks

Retrieves tasks from your account based on filter settings.

Search	Searches through: Title Project Title Description State Assignee Names Tags When using task search, only the following filters are available. Show archived Assigned to current user Uncompleted Starting between Due between Active between All on account
All on Account	Enable this option to retrieve all stories on an account. You can use this field, only if you are a reports viewer or admin.
Filter	Filter returned tasks by the following filters: Name Filter description Show archived Includes archived tasks. Show deleted Includes stories with the deleted_at timestamp. Show from archived projects Select YES to include tasks from Projects that are archived. Story Type Select the task type you want to filter. Sub-tasks not included Enable this option to return parent tasks only. Assigned to current user Select YES to return only stories that are assigned to the current user. Uncompleted Returns uncompleted tasks only. With start or due date Returns only stories that have either a valid start_date or due_date or both. Without past completed Excludes tasks that have the state as completed and have a due date before today Project ID Returns tasks from the selected project only.
Name	Filter description
Show archived	Includes archived tasks.
Show deleted	Includes stories with the deleted_at timestamp.
Show from archived projects	Select YES to include tasks from Projects that are archived.
Story Type	Select the task type you want to filter.
Sub-tasks not included	Enable this option to return parent tasks only.
Assigned to current user	Select YES to return only stories that are assigned to the current user.
Uncompleted	Returns uncompleted tasks only.
With start or due date	Returns only stories that have either a valid start_date or, due_date or both.
Without past completed	Excludes tasks that have the state as completed and have a due date before today
Project ID	Returns tasks from the selected project only.
Limit	Set the maximum number of tasks Ibexa Connect will return during one execution cycle.

Get a Task

Retrieves task details.

Task ID	Select or enter (map) the ID of the task you want to retrieve details about.

Create a Task

Creates a new task, deliverable, or milestone.

Title	Enter the title for the new task. Max 200 characters.
Task Type	Select the type of the task.
Project ID	Select the ID of the Workspace in which the story will be created
Description	Enter a description of the new task - max 1000 characters.
Parent Task ID	If the parent task is selected, the new task will be the sub-task.
Start Date	Enter the start date for the new task in the YYYY-MM-DD format.
Due Date	Enter the due date of the new task in the YYYY-MM-DD format.
Assignee IDs	Select the users that the new task should be assigned..
** Budget Estimation Amount **	Enter the budget of the new task. This is only valid in budgeted projects and when the user can view budget information.
Time Estimate in Minutes	Enter the time estimate in minutes of the new task.
Fixed Fee	Enable if the task is a fixed fee task. Time logged against a fixed fee task does not impact the task's budget. Only present for budgeted projects and if the authenticated user can view budget information.
Billable	Enable this option if the task is billable. Only present for budgeted projects and if the authenticated user can view budget information.
Tags	Specify the tags you want to add to the task.
** Completion Percentage of the Task **	Set the completion percentage of the task; setting above 0 starts the story and setting to 100 completes the story.

Update a Task

Edits a task.

Task ID	Select or map the task you want to update.
Title	Enter the title for the new task. Max 200 characters.
Task Type	Select the type of the task.
Project ID	Select the ID of the Workspace in which the story will be created
Description	Enter a description of the new task - max 1000 characters.
Parent Task ID	If the parent task is selected, the new task will be sub-task.
Start Date	Enter the start date for the new task in the YYYY-MM-DD format.
Due Date	Enter the due date of the new task in the YYYY-MM-DD format.
Assignee IDs	Select the users that the new task should be assigned.
Budget Estimation Amount	Enter the budget of the new task. This is only valid in budgeted Projects and when the user can view budget information.
Time Estimate in Minutes	Enter the time estimate in minutes of the new task.
Fixed Fee	Enable if the task is the fixed fee task. Time logged against a fixed fee task does not impact the task's budget. Only present for budgeted projects and if the authenticated user can view budget information.
Billable	Enable this option if the task is billable. Only present for budgeted projects and if the authenticated user can view budget information.
Tags	Specify the tags you want to add to the task.
Completion Percentage of the Task	Set the completion percentage of the task; setting above 0 starts the story and setting to 100 completes the story.

Delete a Task

Deletes a task.

When you delete a parent task, the sub-task will be also deleted.

Task ID	Select or map the task you want to delete.

Time Entry

Watch Time Entries

Retrieves time entry details when a time entry is created or updated.

Watch Time Entries	Select whether you want to watch created or updated time entries. By creation time By update time
Filter	Filter returned time entry by the following filters: Project ID Select the project you want to watch for time entries. From archived projects Watch also time entries from projects that have been archived.
Limit	Set the maximum number of time entries Ibexa Connect will return during one execution cycle.

List Time Entries

Retrieves time entries based on the filter settings.

Filter

Filter returned time entry by the following filters: Project ID Select the project you want to watch time entries for. From archived projects Watch also time entries from projects that have been archived. Date Performed Check the checkbox to set the filter by the date when a time entry was performed. From Enter the date in the YYYY-MM-DD format. If no date is entered it is interpreted as negative or positive infinity. Until Enter the date in the YYYY-MM-DD format. If no date is entered it is interpreted as negative or positive infinity.

Limit

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

Get Time Entry

Retrieves time entry details.

Time Entry ID	Select or enter (map) the ID of the time entry you want to retrieve details about.

Create a Time Entry

Creates a new time entry.

Project ID	Select or map the project you want to create a time entry for.
Date performed	Enter the date when the activity was performed in YYYY-MM-DD format.
Time in minutes	Enter the time for the time entry (in minutes).
Billable	Check the checkbox if the time of time entry is billable and enter the hourly rate. Rate Enter the hourly rate in cents.
Notes	Enter the note that is added to the time entry.
User ID	Select or enter the ID of the user the time entry is associated with.

Update a Time Entry

Updates a time entry.

Time Entry ID	Select or map the time entry you want to edit.
Project ID	Select or map the project you want to create a time entry for.
Date performed	Enter the date when the activity was performed in YYYY-MM-DD format.
Time in minutes	Enter the time for the time entry (in minutes).
Billable	Check the checkbox if the time of the time entry is billable and enter the hourly rate. Rate Enter the hourly rate in cents.
Rate	Enter the hourly rate in cents.
Notes	Enter the note that is added to the time entry.
User ID	Select or enter the ID of the user the time entry is associated with.

Delete a Time Entry

Delete a time entry.

Time Entry ID	Select or map the time entry you want to delete.

Post

Watch Posts

Retrieves post details when a post is created or updated.

Watch Posts	Select whether you want to watch created or updated posts. By creation time By update time
Filter	Filter returned time entry by the following filters: Project ID Select the project you want to watch time entries for. Parents only Select the YES option to return parent posts without including replies by themselves. From archived projects Select the YES option to Return posts from projects that have been archived.
Limit	Set the maximum number of posts Ibexa Connect will return during one execution cycle.

Add a Post

Adds a post to the project.

Project ID	Select or map the project where you want to add the post.
Message	Enter the text content of the post. Max length is 10 000 characters.
Source File	Map the file you want to upload from the previous module (e.g. HTTP > Get a File or Dropbox > Get a file), or enter the file name (including the file extension) and file data manually.

Other

Make an API Call

Allows you to perform a custom API call.

URL	Enter a path relative to https://api.mavenlink.com/api. E.g. /v1/workspaces.json For the list of available endpoints, refer to the Mavenlink Developer 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 (Workspaces)

The following API call returns all projects in your Mavenlink account:

URL:

/v1/workspaces.json

Method:

GET

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

In our example, 4 projects were returned: