Endpoint: POST /tasks
Body:
name
string
listIds
Array of UUID (one or more)
description
string (optional)
status
string (optional)
assigneesIds
Array of UUID (optional)
parentTaskId
UUID (optional)
fields
Array of fields (optional) (see Task object)
orderIntent
(optional)
Insert this task at the right place in the list.
intent
string: start
, end
, before
, or after
taskId
UUID (only used for before and after intent)links
Array of links (shown below) (optional)
// Zendesk link
{
"url": "<Zendesk url>",
"metadata": {
"type": "zendeskTicket",
"ticketId": 42,
"subject": "<subject>",
"description": "<description>"
}
}
// Notion Link
{
"url": "<Notion url>",
"metadata": {
"type": "notionDocument",
"pageId": "<page id of notion page>",
}
}
// Figma Link
{
"url": "<Figma url>",
"metadata": {
"type": "figmaLink",
"document": {
"id": "<id of figma document>",
"name": "<name of figma document> (optional)"
},
"fileKey": "<file key of figma document>",
"page": {
"id": "<id of figma page>",
"name": "<name of figma page> (optional)"
} | null | undefined,
"frame": {
"id": "<id of figma frame>",
"name": "<name of figma frame> (optional)"
} | null | undefined
}
}
{
metadata: {
"type": "sentryIssue",
"project": {
slug: "<slug of sentry project>",
id: "<id of sentry project>",
},
"issueId": "<issue id of sentry issue>",
}
}
{
metadata: {
"type": "sentryAlert",
"organizationId": "<sentry organization id>",
"lastAlertEvent": "<Date of last alert event>",
"alertRuleId": "<Id of alert rule for sentry alert>",
"lastAlertStatus": "<“critical” or “warning” or “resolved”>"
}
}
Query:
realtime
boolean (optional) (defaults to true
) - use false
when migrating tasksnotifyUsers
boolean (optional) (defaults to true
) - use false
when migrating tasksResponse:
status
: 201 for success
Example request
curl <https://api.height.app/tasks> \\
-H "Authorization: api-key secret_1234" \\
-H "Content-Type: application/json" \\
-d '{"name":"Test task", "listIds": ["0c364c36-1fcc-4f1d-a6f7-340ef931d2a0"], "fields": [{"fieldTemplateId":"fac9a720-2630-4bbc-a86c-7f58865e7d18", "value":"a25bd3a3-3b88-45a8-8acb-c86b04621487"}]}'