Deposit Released — Tenant Email Notification

Overview

When a deposit release is initiated, all tenants on the associated tenancy are automatically notified by email. This workflow is event-driven and requires no manual intervention from landlords, agents, or platform administrators.

How It Works

1. Release is initiated — A landlord or agent calls the initiateRelease mutation to begin the deposit release process.
2. Event emitted — On success, initiateRelease emits a deposit/release.released event.
3. Workflow triggered — The platform listens for deposit/release.released and invokes the depositReleasedEmailFn handler.
4. Emails sent — The handler resolves all tenants linked to the tenancy (via tenancyTenants) and sends each one a tenancy/deposit.released email.

Trigger

Property	Detail
Trigger type	Event-driven
Event name	deposit/release.released
Emitted by	initiateRelease mutation

Recipients

The email is sent to every tenant on the tenancy at the time the event fires. Tenant records are resolved through the tenancyTenants join entity.

Email Template

Property	Value
Template identifier	tenancy/deposit.released
Handler	depositReleasedEmailFn

Entities

The following entities are accessed during this workflow:

• depositReleases — the release record that was created
• tenancies — the parent tenancy
• tenancyTenants — join table linking tenants to the tenancy
• tenants — individual tenant records and contact details
• properties — property details included in the notification

Notes

• The deposit/release.released event is a new event introduced in this release. Any other workflows or subscribers that need to react to a deposit release should listen on this event.
• The depositReleasedEmailFn handler is an existing handler reused by this workflow; no new email template was introduced.