FoyerDevelopers

Generated · Live registry

messaging-rules tools

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

All tool domains

messaging-rules.host-history

read-only

CC-parity 'Verlauf': list ALL outbound Hospitable host messages in an optional date range (YYYY-MM-DD, tenant timezone), attributed to their source — a Foyer messaging rule (by name), Hospitable's own automation ('Automated (Hospitable)'), or a manual host send. Manual sends (included in 'all') are excluded by default (source='all'); pass source='manual' to see them, 'scheduler' for Foyer-rule sends only, or 'hospitable_auto' for Hospitable's automation only. Also returns KPI stats (sent/delivered/failed/tomorrow_planned/week_planned) for the same range. Read-only.

Input parameters

FieldTypeRequiredNotes
fromstringno
tostringno
sourceenumnoOne of: all, scheduler, hospitable_auto, manual

Output fields

FieldTypeRequiredNotes
statsobjectyes
stats.sentnumberyes
stats.deliverednumberyes
stats.failednumberyes
stats.tomorrow_plannednumberyes
stats.week_plannednumberyes
rowsarray of objectyes
rows.idstringyes
rows.sentAtstringyes
rows.bodystring · nullableyes
rows.externalMessageIdstring · nullableyes
rows.deliveryStatusstringyes
rows.guestNamestring · nullableyes
rows.roomsstring · nullableyes
rows.platformstring · nullableyes
rows.ruleSourcestringyes
generatedAtstringyes

messaging-rules.preview-queue-item

writes

Preview a scheduled (pending) messaging-queue item: renders the message with the CURRENT rule template, custom codes, hotel facts and room overrides — exactly what the sender will produce at fire time. Returns language, subject, body and a skippedReason when the item would be skipped (rule disabled, stay missing, empty template). NOT read-only: rendering a template that uses %checkin_url% or %guide_url% creates the guest check-in session if the stay has none yet.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
languagestring · nullableyes
subjectstring · nullableyes
bodystring · nullableyes
skippedReasonstring · nullableyes

messaging-rules.send-queue-item-now

writes

Send ONE pending scheduled-message queue item immediately instead of waiting for its scheduled time. Uses the exact same render+dispatch path as the cron sender. Fails with not_pending when the item is not in 'pending' state.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
statusenumyesOne of: sent, failed
failureReasonstringno