Interface SyncNotification

Notification emitted after a sync run completes or fails

interface SyncNotification {
    Body: string;
    CompanyIntegrationID: string;
    Event: SyncNotificationEvent;
    OccurredAt: Date;
    Result: SyncResult;
    RunID: string;
    Severity: SyncNotificationSeverity;
    Subject: string;
}

Properties

Body: string

Full text body — formatted for human consumption

CompanyIntegrationID: string

ID of the CompanyIntegration that was synced

What happened to trigger this notification

OccurredAt: Date

When the notification was emitted

The aggregate sync result for programmatic access

RunID: string

ID of the run record created for this sync

Overall severity

Subject: string

Human-readable summary suitable for email subject lines