FoyerDevelopers

Generated · Live registry

taskRules tools

9 tools in this domain, generated from the running registry.

All tool domains

taskRules.byId

read-only

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

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumyesOne of: low, normal, high, urgent
titleTemplatestringyes
descriptionTemplatestring · nullableyes
assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
assigneeUserIdstring · nullableyes
icalExportbooleanyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

taskRules.create

writes

Create a new task automation rule.

Input parameters

FieldTypeRequiredNotes
namestringyes
enabledbooleannoDefault: true
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableno
roomScopeTypeenumnoOne of: all, specific — Default: "all"
roomIdsarray of stringnoDefault: []
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumnoOne of: low, normal, high, urgent — Default: "normal"
titleTemplatestringyes
descriptionTemplatestringno
assigneeStrategyenumnoOne of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual"
assigneeUserIdstring · nullablenoDefault: null
icalExportbooleannoDefault: true

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumyesOne of: low, normal, high, urgent
titleTemplatestringyes
descriptionTemplatestring · nullableyes
assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
assigneeUserIdstring · nullableyes
icalExportbooleanyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

taskRules.delete

writesconfirm

Delete a task automation rule.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumyesOne of: low, normal, high, urgent
titleTemplatestringyes
descriptionTemplatestring · nullableyes
assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
assigneeUserIdstring · nullableyes
icalExportbooleanyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

taskRules.dryRun

writes

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

FieldTypeRequiredNotes
ruleobjectyes
rule.namestringyes
rule.enabledbooleannoDefault: true
rule.triggerClassenumyesOne of: booking, ai, external
rule.triggerEventstringyes
rule.triggerOffsetMinutesintegeryes
rule.conditionobject · nullableno
rule.roomScopeTypeenumnoOne of: all, specific — Default: "all"
rule.roomIdsarray of stringnoDefault: []
rule.taskKindenumyesOne of: cleaning, maintenance, delivery, other
rule.taskPriorityenumnoOne of: low, normal, high, urgent — Default: "normal"
rule.titleTemplatestringyes
rule.descriptionTemplatestringno
rule.assigneeStrategyenumnoOne of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual"
rule.assigneeUserIdstring · nullablenoDefault: null
rule.icalExportbooleannoDefault: true
lookbackDaysintegernoDefault: 30

Output fields

FieldTypeRequiredNotes
wouldFireintegeryes
totalEventsScannedintegeryes
samplesarray of objectyes
samples.payloadobjectyes
samples.triggeredAtstringyes

taskRules.executions

read-only

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

FieldTypeRequiredNotes
ruleIdstringyes
pageintegernoDefault: 1
includeDryRunbooleannoDefault: false

Output fields

FieldTypeRequiredNotes
rowsarray of objectyes
rows.idstringyes
rows.tenantIdstringyes
rows.ruleIdstringyes
rows.triggeredAtstringyes
rows.triggerPayloadobjectyes
rows.outcomeenumyesOne of: task_created, condition_false, no_assignee, rule_disabled_during_eval, error
rows.taskIdstring · nullableyes
rows.errorMessagestring · nullableyes
rows.isDryRunbooleanyes
pageintegeryes
hasMorebooleanyes

taskRules.list

read-only

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

FieldTypeRequiredNotes
enabledbooleanno
searchstringno
pageintegernoDefault: 1

Output fields

FieldTypeRequiredNotes
rowsarray of objectyes
rows.idstringyes
rows.tenantIdstringyes
rows.namestringyes
rows.enabledbooleanyes
rows.triggerClassenumyesOne of: booking, ai, external
rows.triggerEventstringyes
rows.triggerOffsetMinutesintegeryes
rows.conditionobject · nullableyes
rows.roomScopeTypeenumyesOne of: all, specific
rows.roomIdsarray of stringyes
rows.taskKindenumyesOne of: cleaning, maintenance, delivery, other
rows.taskPriorityenumyesOne of: low, normal, high, urgent
rows.titleTemplatestringyes
rows.descriptionTemplatestring · nullableyes
rows.assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
rows.assigneeUserIdstring · nullableyes
rows.icalExportbooleanyes
rows.createdAtstringyes
rows.updatedAtstringyes
rows.createdByUserIdstring · nullableyes
pageintegeryes
hasMorebooleanyes

taskRules.toggle

writes

Turns a task rule (id) on or off via enabled. Owner only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
enabledbooleanyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumyesOne of: low, normal, high, urgent
titleTemplatestringyes
descriptionTemplatestring · nullableyes
assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
assigneeUserIdstring · nullableyes
icalExportbooleanyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

taskRules.trigger

writesconfirm

Manually fire a task rule right now — creates its real task(s) immediately, out of band. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
idstringyes
payloadobjectyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

taskRules.update

writes

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

FieldTypeRequiredNotes
idstringyes
namestringno
enabledbooleannoDefault: true
triggerClassenumnoOne of: booking, ai, external
triggerEventstringno
triggerOffsetMinutesintegerno
conditionobject · nullableno
roomScopeTypeenumnoOne of: all, specific — Default: "all"
roomIdsarray of stringnoDefault: []
taskKindenumnoOne of: cleaning, maintenance, delivery, other
taskPriorityenumnoOne of: low, normal, high, urgent — Default: "normal"
titleTemplatestringno
descriptionTemplatestringno
assigneeStrategyenumnoOne of: manual, fixed_user, preferred_for_room, round_robin — Default: "manual"
assigneeUserIdstring · nullablenoDefault: null
icalExportbooleannoDefault: true

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, external
triggerEventstringyes
triggerOffsetMinutesintegeryes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
taskKindenumyesOne of: cleaning, maintenance, delivery, other
taskPriorityenumyesOne of: low, normal, high, urgent
titleTemplatestringyes
descriptionTemplatestring · nullableyes
assigneeStrategyenumyesOne of: manual, fixed_user, preferred_for_room, round_robin
assigneeUserIdstring · nullableyes
icalExportbooleanyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes