FoyerDevelopers

Generated · Live registry

notificationRules tools

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

All tool domains

notificationRules.byId

read-only

Returns a notification rule (id) with trigger, condition, recipient filter, channels and templates. 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, task, incident, security, external
triggerEventstringyes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullableyes
channelsarray of enumyes
subjectTemplatestring · nullableyes
bodyTemplatestringyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

notificationRules.create

writes

Create a new notification rule.

Input parameters

FieldTypeRequiredNotes
namestringyes
enabledbooleannoDefault: true
triggerClassenumyesOne of: booking, ai, task, incident, security, external
triggerEventstringyes
conditionobject · nullableno
roomScopeTypeenumnoOne of: all, specific — Default: "all"
roomIdsarray of stringnoDefault: []
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullablenoDefault: null
channelsarray of enumyes
subjectTemplatestring · nullableno
bodyTemplatestringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, task, incident, security, external
triggerEventstringyes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullableyes
channelsarray of enumyes
subjectTemplatestring · nullableyes
bodyTemplatestringyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

notificationRules.delete

writesconfirm

Delete a notification rule.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, task, incident, security, external
triggerEventstringyes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullableyes
channelsarray of enumyes
subjectTemplatestring · nullableyes
bodyTemplatestringyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

notificationRules.dryRun

writes

Dry run of a notification rule that has not been saved yet: replays it against already logged events over lookbackDays (1 to 90, default 30) and reports how often it would have fired, how often a recipient could have been determined, plus up to 10 examples. Owner only. Changes nothing and sends nothing. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
ruleobjectyes
rule.namestringyes
rule.enabledbooleannoDefault: true
rule.triggerClassenumyesOne of: booking, ai, task, incident, security, external
rule.triggerEventstringyes
rule.conditionobject · nullableno
rule.roomScopeTypeenumnoOne of: all, specific — Default: "all"
rule.roomIdsarray of stringnoDefault: []
rule.recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
rule.recipientUserIdstring · nullablenoDefault: null
rule.channelsarray of enumyes
rule.subjectTemplatestring · nullableno
rule.bodyTemplatestringyes
lookbackDaysintegernoDefault: 30

Output fields

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

notificationRules.executions

read-only

Lists the execution log of a notification rule (ruleId): trigger time, result (sent, condition_false, no_recipient, send_failed, opted_out …), channel used, error text; newest first, 50 per page, dry runs only with includeDryRun. Any signed-in role. Read-only.

Input parameters

FieldTypeRequiredNotes
ruleIdstringyes
pageintegernoDefault: 1
includeDryRunbooleannoDefault: false
outcomeenumnoOne of: sent, condition_false, no_recipient, no_channel, send_failed, opted_out, rule_disabled

Output fields

FieldTypeRequiredNotes
rowsarray of objectyes
rows.idstringyes
rows.tenantIdstringyes
rows.ruleIdstringyes
rows.triggeredAtstringyes
rows.triggerPayloadobjectyes
rows.recipientUserIdstring · nullableyes
rows.channelUsedenum · nullableyesOne of: email, sms, whatsapp, push, none
rows.outcomeenumyesOne of: sent, condition_false, no_recipient, no_channel, send_failed, opted_out, rule_disabled
rows.errorMessagestring · nullableyes
rows.isDryRunbooleanyes
pageintegeryes
hasMorebooleanyes

notificationRules.list

read-only

Lists the property's notification rules (trigger, condition, recipients, channels, template, 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, task, incident, security, external
rows.triggerEventstringyes
rows.conditionobject · nullableyes
rows.roomScopeTypeenumyesOne of: all, specific
rows.roomIdsarray of stringyes
rows.recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
rows.recipientUserIdstring · nullableyes
rows.channelsarray of enumyes
rows.subjectTemplatestring · nullableyes
rows.bodyTemplatestringyes
rows.createdAtstringyes
rows.updatedAtstringyes
rows.createdByUserIdstring · nullableyes
pageintegeryes
hasMorebooleanyes

notificationRules.toggle

writes

Turns a notification 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, task, incident, security, external
triggerEventstringyes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullableyes
channelsarray of enumyes
subjectTemplatestring · nullableyes
bodyTemplatestringyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes

notificationRules.trigger

writesconfirm

Manually fire a notification rule right now — sends the rule's real notification(s) immediately, out of band. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
idstringyes
payloadobjectyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

notificationRules.update

writes

Replaces all fields of a notification rule (id plus the complete rule definition: name, trigger, condition, room scope, recipient filter, channels email/sms/whatsapp/push, templates). Owner only. Changes data; the email channel requires a subject. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringyes
enabledbooleannoDefault: true
triggerClassenumyesOne of: booking, ai, task, incident, security, external
triggerEventstringyes
conditionobject · nullableno
roomScopeTypeenumnoOne of: all, specific — Default: "all"
roomIdsarray of stringnoDefault: []
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullablenoDefault: null
channelsarray of enumyes
subjectTemplatestring · nullableno
bodyTemplatestringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
enabledbooleanyes
triggerClassenumyesOne of: booking, ai, task, incident, security, external
triggerEventstringyes
conditionobject · nullableyes
roomScopeTypeenumyesOne of: all, specific
roomIdsarray of stringyes
recipientFilterenumyesOne of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
recipientUserIdstring · nullableyes
channelsarray of enumyes
subjectTemplatestring · nullableyes
bodyTemplatestringyes
createdAtstringyes
updatedAtstringyes
createdByUserIdstring · nullableyes