All Docs
FeaturesDepositClearUpdated March 13, 2026

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:

ChannelDetails
In-app notificationMarked as urgent. Shows which PMS integration failed and the error message returned by the sync.
EmailSame 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:

  1. Click the link in the email (or navigate to Settings → Integrations).
  2. Review the error message displayed on the affected connection.
  3. Common causes include expired API credentials, revoked access tokens, or a temporary outage on the PMS provider side.
  4. Re-authenticate or reconfigure the connection as needed.
  5. Trigger a manual resync or wait for the next scheduled sync cycle.

Affected Data Entities

  • pms_connections — the integration connection record that failed
  • pms_sync_logs — the log entry capturing the error details
  • org_members — used to identify admin/owner recipients
  • notifications — stores the in-app notification record
  • users — used to resolve member contact details for email delivery

Related