notificationRules tools · Foyer Connect

`notificationRules.byId`

read-only

Notification rules: by id. Read-only query. See the input schema for argument details.

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, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	yes
`roomScopeType`	enum	yes	One of: all, specific
`roomIds`	array of string	yes
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	yes
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	yes
`bodyTemplate`	string	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`notificationRules.create`

writes

Create a new notification rule.

Input parameters

Field	Type	Required	Notes
`name`	string	yes
`enabled`	boolean	no	Default: true
`triggerClass`	enum	yes	One of: booking, ai, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	no
`roomScopeType`	enum	no	One of: all, specific — Default: "all"
`roomIds`	array of string	no	Default: []
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	no	Default: null
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	no
`bodyTemplate`	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, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	yes
`roomScopeType`	enum	yes	One of: all, specific
`roomIds`	array of string	yes
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	yes
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	yes
`bodyTemplate`	string	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`notificationRules.delete`

writesconfirm

Delete a notification 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, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	yes
`roomScopeType`	enum	yes	One of: all, specific
`roomIds`	array of string	yes
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	yes
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	yes
`bodyTemplate`	string	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`notificationRules.dryRun`

writes

Notification rules: dry run. Mutation — changes data. See the input schema for argument details.

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, task, external
`rule.triggerEvent`	string	yes
`rule.condition`	object · nullable	no
`rule.roomScopeType`	enum	no	One of: all, specific — Default: "all"
`rule.roomIds`	array of string	no	Default: []
`rule.recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`rule.recipientUserId`	string · nullable	no	Default: null
`rule.channels`	array of enum	yes
`rule.subjectTemplate`	string · nullable	no
`rule.bodyTemplate`	string	yes
`lookbackDays`	integer	no	Default: 30

Output fields

Field	Type	Required
`wouldFire`	integer	yes
`wouldHaveRecipient`	integer	yes
`totalEventsScanned`	integer	yes
`samples`	array of object	yes
`samples.payload`	object	yes
`samples.triggeredAt`	string	yes

`notificationRules.executions`

read-only

Notification rules: executions. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`ruleId`	string	yes
`page`	integer	no	Default: 1
`includeDryRun`	boolean	no	Default: false
`outcome`	enum	no	One of: sent, condition_false, no_recipient, no_channel, send_failed, opted_out, rule_disabled

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.recipientUserId`	string · nullable	yes
`rows.channelUsed`	enum · nullable	yes	One of: email, sms, whatsapp, none
`rows.outcome`	enum	yes	One of: sent, condition_false, no_recipient, no_channel, send_failed, opted_out, rule_disabled
`rows.errorMessage`	string · nullable	yes
`rows.isDryRun`	boolean	yes
`page`	integer	yes
`hasMore`	boolean	yes

`notificationRules.list`

read-only

Notification rules: list. Read-only query. See the input schema for argument details.

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, task, external
`rows.triggerEvent`	string	yes
`rows.condition`	object · nullable	yes
`rows.roomScopeType`	enum	yes	One of: all, specific
`rows.roomIds`	array of string	yes
`rows.recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`rows.recipientUserId`	string · nullable	yes
`rows.channels`	array of enum	yes
`rows.subjectTemplate`	string · nullable	yes
`rows.bodyTemplate`	string	yes
`rows.createdAt`	string	yes
`rows.updatedAt`	string	yes
`rows.createdByUserId`	string · nullable	yes
`page`	integer	yes
`hasMore`	boolean	yes

`notificationRules.toggle`

writes

Notification rules: toggle. Mutation — changes data. See the input schema for argument details.

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, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	yes
`roomScopeType`	enum	yes	One of: all, specific
`roomIds`	array of string	yes
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	yes
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	yes
`bodyTemplate`	string	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes

`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

Field	Type	Required	Notes
`id`	string	yes
`payload`	object	yes

Output fields

Field	Type	Required	Notes
`ok`	boolean	yes

`notificationRules.update`

writes

Notification rules: update. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`id`	string	yes
`name`	string	yes
`enabled`	boolean	no	Default: true
`triggerClass`	enum	yes	One of: booking, ai, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	no
`roomScopeType`	enum	no	One of: all, specific — Default: "all"
`roomIds`	array of string	no	Default: []
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	no	Default: null
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	no
`bodyTemplate`	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, task, external
`triggerEvent`	string	yes
`condition`	object · nullable	yes
`roomScopeType`	enum	yes	One of: all, specific
`roomIds`	array of string	yes
`recipientFilter`	enum	yes	One of: task_assignee, role_owner, role_staff, role_housekeeping, role_maintenance, specific_user, all_team
`recipientUserId`	string · nullable	yes
`channels`	array of enum	yes
`subjectTemplate`	string · nullable	yes
`bodyTemplate`	string	yes
`createdAt`	string	yes
`updatedAt`	string	yes
`createdByUserId`	string · nullable	yes