PMS Sync Failure Notification
PMS Sync Failure Notification
Overview
When a Property Management System (PMS) integration fails to sync, DepositLink automatically alerts the right people in your organisation — instantly. No manual monitoring required.
How It Works
This feature is an event-driven workflow that fires automatically whenever the PMS sync service marks a connection as failed.
Trigger
The workflow listens for the internal event:
pms/connection.sync.failed
This event is emitted by the pms-connection-sync service as soon as it records status=error against a sync attempt.
Who Gets Notified
Notifications are sent to all members of the affected organisation who hold either an Admin or Owner role. Standard members are not notified.
What the Notification Contains
Each notified admin/owner receives two notifications simultaneously:
| Channel | Details |
|---|---|
| In-app notification | Marked as urgent. Shows which PMS integration failed and the error message returned by the sync. |
| Same failure details, plus a direct link to the organisation's integrations settings page. |
Why This Matters
A broken PMS sync can mean stale tenancy data, missed move-out dates, or incorrect deposit records. Catching and resolving sync failures quickly keeps your data accurate and your deposit workflows uninterrupted.
Resolving a Sync Failure
When you receive a PMS sync failure notification:
- Click the link in the email (or navigate to Settings → Integrations).
- Review the error message displayed on the affected connection.
- Common causes include expired API credentials, revoked access tokens, or a temporary outage on the PMS provider side.
- Re-authenticate or reconfigure the connection as needed.
- Trigger a manual resync or wait for the next scheduled sync cycle.
Affected Data Entities
pms_connections— the integration connection record that failedpms_sync_logs— the log entry capturing the error detailsorg_members— used to identify admin/owner recipientsnotifications— stores the in-app notification recordusers— used to resolve member contact details for email delivery