Create New Task API

Create new Tasks in Rhythm with this API

Open in New Tab →

Method Details

HTTP Method: POST

URL: https://api.rhythm.cloud/api/public/task 

Content Type: application/json

Response Format: json

Requires Authentication? Yes

HTTP header: Bearer {oath token}

Request Body


JSON Objects, containing the following fields (strings should be double quoted, numbers and boolean not):

name: Name or title of the task. (This is required.)

teamName: Team name in Rhythm for task

Note: If you do not specify, the new task will be assigned to the default team for the API Admin creating the integration. If the API Admin has no default team and you do not specify a team, the Task will go to the Company Team.

ownerUsername: Rhythm Username (usually work email address) for the owner of the new tasks. (If you do not specify an owner, new tasks will have the API Admin setting up the integration assigned as owner)

dueDate: yyyy-MM-dd (If you do not specify a due date, the Task will be due on the date it is created)

completed: true | false (If you don’t specify, the new Task will not be marked completed)

hours : number of hours

context: any context for the task

workedBy: name of person working on the task

Response

If all items in the request were processed successfully, you will receive a http code 200 (OK), with a JSON of {"success":true} in the response body.

If the access token has expired, you will receive a http code 401 (unauthorized).

If some items in the request processed successfully, and some failed, you will receive a http code 202 (Accepted). If all items in the request failed, the API call will result in a http code 400 (bad request). In both these instances, the response body will contain a JSON array, where each JSON Object contains additional information about the failed item, the following format:

[{

"error": "error code used by Rhythm Systems for further trouble shooting",

"error_description": "description of the error encountered in the API call",

"data": "{the data received by Rhythm in your API call}"

},

{

"error": "error code used by Rhythm Systems for further trouble shooting",

"error_description": "description of the error encountered in the API call",

"data": "{the data received by Rhythm in your API call}"

}]

Request Body Sample

{

  "name" : "New TASK created with API",

  "ownerUsername" : "jessica@rhythmsystems.com",

  "teamName" : "Product",

  "context" : "some additional info",

  "dueDate": "2022-10-04",

  "hours" : 2,

  "workedBy" : "name",

  "completed" : true