TaskCreateOptions
Options for creating a task.
type defaults to TaskType.External when omitted. For a schema-first
HITL task, set type: TaskType.QuickForm and provide taskSchemaKey and
schema: the schema is registered under taskSchemaKey on first use and
reused (not updated) on later calls with the same key (keys are unique per
tenant).
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
actionableMessageMetaData? |
Record<string, unknown> |
When omitted on a QuickForm task, the backend derives it from the referenced schema. |
creatorJobKey? |
string |
Identifies the job that triggered the schema creation (paired with schema). |
data? |
Record<string, unknown> |
- |
isActionableMessageEnabled? |
boolean |
Enables actionable (e.g. Outlook) notifications for a QuickForm task. |
labels? |
string[] |
Free-form labels shown on the task. Supported for all task types. |
priority? |
TaskPriority |
- |
schema? |
Record<string, unknown> |
Inline schema body for a QuickForm task, registered under taskSchemaKey on first use. |
taskSchemaKey? |
string |
Schema key for a QuickForm task. Required when type is TaskType.QuickForm; ignored for other task types. |
title |
string |
- |
type? |
TaskType |
Task type. Defaults to TaskType.External when omitted. |