taskRules.byId
Returns a task rule (id) with trigger, time offset, condition, task template and assignment strategy. Any signed-in role. Read-only; an unknown id yields NOT_FOUND.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
enabled | boolean | yes | |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | yes | |
roomScopeType | enum | yes | One of: all, specific |
roomIds | array of string | yes | |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | yes | One of: low, normal, high, urgent |
titleTemplate | string | yes | |
descriptionTemplate | string · nullable | yes | |
assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
assigneeUserId | string · nullable | yes | |
icalExport | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
taskRules.create
Create a new task automation rule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
enabled | boolean | no | Default: true |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | no | |
roomScopeType | enum | no | One of: all, specific — Default: "all" |
roomIds | array of string | no | Default: [] |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | no | One of: low, normal, high, urgent — Default: "normal" |
titleTemplate | string | yes | |
descriptionTemplate | string | no | |
assigneeStrategy | enum | no | One of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual" |
assigneeUserId | string · nullable | no | Default: null |
icalExport | boolean | no | Default: true |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
enabled | boolean | yes | |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | yes | |
roomScopeType | enum | yes | One of: all, specific |
roomIds | array of string | yes | |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | yes | One of: low, normal, high, urgent |
titleTemplate | string | yes | |
descriptionTemplate | string · nullable | yes | |
assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
assigneeUserId | string · nullable | yes | |
icalExport | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
taskRules.delete
Delete a task automation rule.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
enabled | boolean | yes | |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | yes | |
roomScopeType | enum | yes | One of: all, specific |
roomIds | array of string | yes | |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | yes | One of: low, normal, high, urgent |
titleTemplate | string | yes | |
descriptionTemplate | string · nullable | yes | |
assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
assigneeUserId | string · nullable | yes | |
icalExport | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
taskRules.dryRun
Dry run of a not-yet-saved task rule: replays its condition over lookbackDays (1 to 90, default 30) against already logged events and reports how often it would have fired, plus up to 10 examples. Owner only. Changes nothing and creates no tasks. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
rule | object | yes | |
rule.name | string | yes | |
rule.enabled | boolean | no | Default: true |
rule.triggerClass | enum | yes | One of: booking, ai, external |
rule.triggerEvent | string | yes | |
rule.triggerOffsetMinutes | integer | yes | |
rule.condition | object · nullable | no | |
rule.roomScopeType | enum | no | One of: all, specific — Default: "all" |
rule.roomIds | array of string | no | Default: [] |
rule.taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
rule.taskPriority | enum | no | One of: low, normal, high, urgent — Default: "normal" |
rule.titleTemplate | string | yes | |
rule.descriptionTemplate | string | no | |
rule.assigneeStrategy | enum | no | One of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual" |
rule.assigneeUserId | string · nullable | no | Default: null |
rule.icalExport | boolean | no | Default: true |
lookbackDays | integer | no | Default: 30 |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
wouldFire | integer | yes | |
totalEventsScanned | integer | yes | |
samples | array of object | yes | |
samples.payload | object | yes | |
samples.triggeredAt | string | yes |
taskRules.executions
Lists the execution log of a task rule (ruleId): trigger time, result (task_created, condition_false, no_assignee, error …), created task; newest first, 50 per page, dry runs only with includeDryRun. Any signed-in role. Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
ruleId | string | yes | |
page | integer | no | Default: 1 |
includeDryRun | boolean | no | Default: false |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
rows | array of object | yes | |
rows.id | string | yes | |
rows.tenantId | string | yes | |
rows.ruleId | string | yes | |
rows.triggeredAt | string | yes | |
rows.triggerPayload | object | yes | |
rows.outcome | enum | yes | One of: task_created, condition_false, no_assignee, rule_disabled_during_eval, error |
rows.taskId | string · nullable | yes | |
rows.errorMessage | string · nullable | yes | |
rows.isDryRun | boolean | yes | |
page | integer | yes | |
hasMore | boolean | yes |
taskRules.list
Lists the property's task rules (trigger, time offset, condition, task type, priority, assignment, enabled), most recently changed first, with an enabled filter and name search, 50 per page (page). Any signed-in role. Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
enabled | boolean | no | |
search | string | no | |
page | integer | no | Default: 1 |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
rows | array of object | yes | |
rows.id | string | yes | |
rows.tenantId | string | yes | |
rows.name | string | yes | |
rows.enabled | boolean | yes | |
rows.triggerClass | enum | yes | One of: booking, ai, external |
rows.triggerEvent | string | yes | |
rows.triggerOffsetMinutes | integer | yes | |
rows.condition | object · nullable | yes | |
rows.roomScopeType | enum | yes | One of: all, specific |
rows.roomIds | array of string | yes | |
rows.taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
rows.taskPriority | enum | yes | One of: low, normal, high, urgent |
rows.titleTemplate | string | yes | |
rows.descriptionTemplate | string · nullable | yes | |
rows.assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
rows.assigneeUserId | string · nullable | yes | |
rows.icalExport | boolean | yes | |
rows.createdAt | string | yes | |
rows.updatedAt | string | yes | |
rows.createdByUserId | string · nullable | yes | |
page | integer | yes | |
hasMore | boolean | yes |
taskRules.toggle
Turns a task rule (id) on or off via enabled. Owner only. Changes data. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
enabled | boolean | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
enabled | boolean | yes | |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | yes | |
roomScopeType | enum | yes | One of: all, specific |
roomIds | array of string | yes | |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | yes | One of: low, normal, high, urgent |
titleTemplate | string | yes | |
descriptionTemplate | string · nullable | yes | |
assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
assigneeUserId | string · nullable | yes | |
icalExport | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |
taskRules.trigger
Manually fire a task rule right now — creates its real task(s) immediately, out of band. Requires confirmation.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
payload | object | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes |
taskRules.update
Partially changes a task rule (id); only the fields passed of the rule definition (name, trigger, time offset, condition, room scope, task type, priority, title and description template, assignment, iCal export) are changed. Owner only. Changes data. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
name | string | no | |
enabled | boolean | no | Default: true |
triggerClass | enum | no | One of: booking, ai, external |
triggerEvent | string | no | |
triggerOffsetMinutes | integer | no | |
condition | object · nullable | no | |
roomScopeType | enum | no | One of: all, specific — Default: "all" |
roomIds | array of string | no | Default: [] |
taskKind | enum | no | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | no | One of: low, normal, high, urgent — Default: "normal" |
titleTemplate | string | no | |
descriptionTemplate | string | no | |
assigneeStrategy | enum | no | One of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual" |
assigneeUserId | string · nullable | no | Default: null |
icalExport | boolean | no | Default: true |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
tenantId | string | yes | |
name | string | yes | |
enabled | boolean | yes | |
triggerClass | enum | yes | One of: booking, ai, external |
triggerEvent | string | yes | |
triggerOffsetMinutes | integer | yes | |
condition | object · nullable | yes | |
roomScopeType | enum | yes | One of: all, specific |
roomIds | array of string | yes | |
taskKind | enum | yes | One of: cleaning, maintenance, delivery, other |
taskPriority | enum | yes | One of: low, normal, high, urgent |
titleTemplate | string | yes | |
descriptionTemplate | string · nullable | yes | |
assigneeStrategy | enum | yes | One of: manual, fixed_user, preferred_for_room, round_robin |
assigneeUserId | string · nullable | yes | |
icalExport | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
createdByUserId | string · nullable | yes |