Tenant Deduction Response Submitted — Notification Workflow
Tenant Deduction Response Submitted — Notification Workflow
When a tenant reviews proposed deposit deductions and submits their response, DepositBase automatically notifies the relevant agent team — both by email and via in-app notifications — so no response goes unactioned.
Overview
| Property | Value |
|---|---|
| Trigger | tenancy/tenant.deduction_response.submitted |
| Fired by | submitResponse mutation |
| Notification channels | Email + in-app |
| Recipients | Org agent team |
How It Works
1. Tenant Submits a Response
The workflow is initiated when a tenant calls the submitResponse mutation, which records their position on each proposed deduction (accepted or disputed) and marks the response as submitted.
2. Event Emitted
The system emits the tenancy/tenant.response event. The event payload includes:
- Full dispute breakdown — which deduction items the tenant is disputing and the reasons provided.
- Full acceptance breakdown — which deduction items the tenant has accepted.
- References to the associated
depositReleaseandtenantDeductionItemResponsesrecords.
3. Email Notification
The emitted event is consumed by the existing tenantResponseEmail handler, which sends an email summarising the tenant's response to the appropriate recipients.
4. In-App Notifications
In-app notifications are created in tenantDeductionNotifications for every agent in the organisation's agent team, surfacing the submission directly in their DepositBase dashboard.
Entities
tenantDeductionNotifications
Stores the in-app notifications generated for each org agent when a tenant response is submitted.
tenantDeductionItemResponses
Holds the per-item response data (accepted / disputed) submitted by the tenant. This is the primary source of the event payload breakdown.
depositReleases
The deposit release record associated with the tenancy being resolved. Linked to the event for context and routing.
organizations
Used to resolve the full agent team for the organisation, determining which agents receive in-app notifications.