Skip to content
emailkit
Esc
navigateopen⌘Jpreview
On this page

webhook.onSyncRequired

Events may have been missed — run a sync to replay the gap.

Fires when emailkit detects that events may have been missed — notifications were dropped or the provider reports a history gap (reason says which). Run a sync for the affected scope to replay what was missed through the same hooks.

hooks: {
  webhook: {
    onSyncRequired: async (event) => {
      await jobs.enqueue("emailkit-sync", {
        emailDriver: event.emailDriver,
        scope: event.scope,
        target: event.target,
      });
    },
  },
},

Payload

PropType
id?string
Typestring
emailDriverstring
Typestring
actionWebhookLifecycleAction
TypeWebhookLifecycleAction
sourceWebhookLifecycleSource
TypeWebhookLifecycleSource
reasonWebhookLifecycleReason
TypeWebhookLifecycleReason
recommendedActions?WebhookRecommendedAction[]
TypeWebhookRecommendedAction[]
scopeWebhookScope
TypeWebhookScope
webhook?Webhook
TypeWebhook
previousWebhook?Webhook
TypeWebhook
webhookId?string
Typestring
providerId?string
Typestring
subscriptionId?string
Typestring
target?WebhookLifecycleTarget
TypeWebhookLifecycleTarget
status?WebhookStatus
TypeWebhookStatus
previousStatus?WebhookStatus
TypeWebhookStatus
expiresAt?Date
TypeDate
renewAfter?Date
TypeDate
receivedAt?Date
TypeDate
severity?"info" | "warning" | "critical"
Type"info" | "warning" | "critical"
context?unknown
Typeunknown
raw?unknown
Typeunknown

Last updated on July 24, 2026

Was this page helpful?