Alerts (SDK)

const { createDBDock, BackupService } = require('dbdock');

const dbdock = await createDBDock();
const backups = dbdock.get(BackupService);

// Alerts fire automatically based on dbdock.config.json
const result = await backups.createBackup({ compress: true, encrypt: true });

const { createDBDock, AlertService } = require('dbdock');

const dbdock = await createDBDock();
const alerts = dbdock.get(AlertService);

await alerts.sendSuccess({
  database: 'myapp',
  backupId: 'custom-2026-04-17-001',
  size: 45_000_000,
  duration: 8_500,
});

interface SuccessDetails {
  database: string;
  backupId: string;
  size: number;
  compressedSize?: number;
  duration: number;
  storageKey?: string;
  encrypted?: boolean;
}

interface FailureDetails {
  database: string;
  error: Error | string;
  context?: Record<string, unknown>;
}

{
  "alerts": {
    "slack": { "enabled": true },
    "email": { "enabled": false }
  }
}

const { createDBDock, BackupService } = require('dbdock');

const dbdock = await createDBDock();  // dbdock.config.json has alerts disabled
const backups = dbdock.get(BackupService);

try {
  const result = await backups.createBackup({ compress: true, encrypt: true });
  await myCustomAlert.success({
    text: `Backup ${result.metadata.id} OK`,
    blocks: [/* whatever format your alerting system uses */],
  });
} catch (err) {
  await myCustomAlert.failure({
    text: `Backup failed: ${err.message}`,
  });
}