Articles on: API

Task mail integration

Task mail integration



You enable a project email address to receive emails and create tasks from them.

When using this email, you can either respond to a task (a comment is added) or create a new task.

You company needs to have enabled the Task mail plugin


Enable plugin



The plugin is enabled in the project settings, and you must be an admin to do this.

Go to the project settings
Click on the "Advanced" tab
Click on the "Enbale Task mail"


Project email



The email will have the following format:

project+IDENTIFIER@api.cxplanner.com



Creating a new task



There are two ways to create a new task. The first is simple, and the second is more complex.


Simple



Write an email and just ensure, that the email-content is the task name. When our API reaches the first new line, it will stop parsing the mail.

Send to: project+@api.cxplanner.com
Subject: My new task
Body:
This lines is included
And this line

But this line is not included due to newline before


Complex



The complex way gives you more control over the task. You can add a longer name with line breaks, and you can set the status and assign people.

The example below will:

Create a task
Set the status to "Active" (if that status exists)
Assign the task to Thomas T (if that person exists and is a member of the project).

Send to: project+@api.cxplanner.com
Subject: My new task
Body:
#status: Active
#assigned: Thomas T
#start This lines is included
And this line
And this line #end



Updating a task (adding a comment)



Write an email and just ensure, that the email-content is the task name. When our API reaches the first new line, it will stop parsing the mail.

The subject of the email MUST contain the task ID.

The example below will: 1. Find task with ID 122 2. Add a comment to the task

Send to: project+@api.cxplanner.com
Subject: TaskID 122
Body:
This lines is included
And this line

But this line is not included due to newline before

Updated on: 10/14/2023

Was this article helpful?

Share your feedback

Cancel

Thank you!