All Docs
FeaturesDepositClearUpdated March 14, 2026

Prescribed Information Auto-Generation Trigger

Prescribed Information Auto-Generation Trigger

Overview

When a deposit is first protected on a tenancy, the platform automatically detects this and prompts the responsible party to generate the Prescribed Information document — helping landlords and agents stay compliant with the statutory 30-day serving deadline.

How It Works

Trigger

The workflow listens for the tenancy.updated event and fires when all of the following conditions are true:

ConditionDetail
depositProtectionRefChanged from null to a non-null value (first-time protection)
depositSchemeIs not 'none'

This means the trigger fires once per tenancy, only at the moment the deposit is first registered with a protection scheme.

What the System Does

  1. Checks for an existing document — queries prescribedInfoDocs to determine whether a Prescribed Information document has already been created for the tenancy.

  2. If no document exists:

    • Raises a high-priority in-app notification targeted at the relevant orgMembers.
    • The notification includes a direct CTA to generate the Prescribed Information document.
    • Computes and displays the remaining days left of the 30-day statutory service deadline.

  3. Audit log entry — all trigger activity is written to the auditLog for compliance and traceability.

Notification

The in-app notification surfaces immediately after the deposit protection reference is recorded. It is marked high-priority so it appears prominently in the notification feed.

The notification includes:

  • A summary confirming the deposit has been protected
  • The number of days remaining to serve Prescribed Information (out of the 30-day window)
  • A one-click CTA to begin document generation

Note: If a prescribedInfoDoc already exists for the tenancy at the time the trigger fires, no notification is raised.

Compliance Context

Under the Renters' Rights Act and existing tenancy deposit legislation, landlords and agents are required to serve Prescribed Information to the tenant(s) within 30 days of receiving the deposit. Failure to do so can result in penalties and restrictions on serving notices.

This trigger ensures that the moment a deposit protection reference is recorded in the platform, the responsible party is immediately alerted and guided to fulfil this obligation.

Entities

EntityRole
tenanciesSource of the tenancy.updated event; provides depositProtectionRef and depositScheme
prescribedInfoDocsChecked for an existing document; target of the generation CTA
notificationsHigh-priority notification raised for org members
orgMembersRecipients of the notification
auditLogRecords all trigger activity for compliance purposes

Related