v3

latestSwagger 2.02026-08-067506752.0 MB

task

Create a task

post/v1/org/{orgId}/task

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

orgIdstring required

parent organization id

userIdstring required

user who is responsible for the task

assessmentIdstring

parent assessment id that this task belongs to

parentEntityIdstring

parent entity id that this task belongs to, should be used with entityId

type of task

entityIdstring required

the primary entity being referenced by the task - for example for a FORM_SUBMIT, this will be the form

targetIdstring

the optional target entity being referenced by the task - for example for a FORM_SUBMIT, this will be the person

categoryIdstring

the data category that the task belongs to

status'PENDING' | 'DONE' | 'EXPIRED' | 'SKIPPED' required

status of this task

labelstring

The user-visible label for the task; if not set, will automatically default based on the task type

messagestring

The message attached to this task

pathstring

the optional path of this task (only applies to Type == ORG_IMPORT)

taskConfigIdstring

id of the TaskConfig

slugstring

slug used to reference tasks in events

dueAtstring

due date for the task

pastDueAction'NONE' | 'SET_EXPIRED'

what action to take when the task is past its due date

isSkippableboolean

check for if the task can be skipped

Example request

{
  "orgId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "assessmentId": "588f7ee98f138b19220041a7",
  "parentEntityId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7",
  "targetId": "588f7ee98f138b19220041a7",
  "categoryId": "588f7ee98f138b19220041a7",
  "message": "this is the best task ever",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "taskConfigId": "588f7ee98f138b19220041a7",
  "slug": "onboardingForm",
  "pastDueAction": "NONE"
}

Response

task created

idstring required

globally unique id

orgIdstring required

parent organization id

userIdstring required

user who is responsible for the task

assessmentIdstring

parent assessment id that this task belongs to

parentEntityIdstring

parent entity id that this task belongs to, should be used with entityId

type of task

entityIdstring required

the primary entity being referenced by the task - for example for a FORM_SUBMIT, this will be the form

targetIdstring

the optional target entity being referenced by the task - for example for a FORM_SUBMIT, this will be the person

categoryIdstring

the data category that the task belongs to

actionIdstring

the action that created the task, if the task was generated from an action

status'PENDING' | 'DONE' | 'EXPIRED' | 'SKIPPED' required

status of this task

doneAtstring

timestamp that the task was done, if it was done

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

labelstring

The user-visible label for the task; if not set, will automatically default based on the task type

messagestring

The message attached to this task

pathstring

the optional path of this task (only applies to Type == ORG_IMPORT)

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteBehalfIdstring

deleted on behalf of user id

deleteAtstring

deleted timestamp

taskConfigIdstring

id of the TaskConfig

slugstring

slug used to reference tasks in events

dueAtstring

due date for the task

pastDueAction'NONE' | 'SET_EXPIRED'

what action to take when the task is past its due date

isSkippableboolean

check for if the task can be skipped

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "assessmentId": "588f7ee98f138b19220041a7",
  "parentEntityId": "588f7ee98f138b19220041a7",
  "entityId": "588f7ee98f138b19220041a7",
  "targetId": "588f7ee98f138b19220041a7",
  "categoryId": "588f7ee98f138b19220041a7",
  "actionId": "588f7ee98f138b19220041a7",
  "doneAt": "2017-01-24T13:57:52Z",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "message": "this is the best task ever",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteBehalfId": "588f7ee98f138b19220041a7",
  "deleteAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "deleteAt": "2017-01-24T13:57:52Z",
  "taskConfigId": "588f7ee98f138b19220041a7",
  "slug": "onboardingForm",
  "pastDueAction": "NONE"
}