Skip to content
emailkit
Esc
navigateopen⌘Jpreview
On this page

webhook.onActionRequired

A subscription needs your app's help — auth revoked, endpoint unreachable.

Fires when emailkit can’t fix a subscription on its own — auth was revoked, the endpoint is unreachable, deliveries are failing. reason says what happened and recommendedActions say what to do next (reauthorize, recreate, fix_endpoint, …).

hooks: {
  webhook: {
    onActionRequired: async (event) => {
      if (event.recommendedActions?.includes("reauthorize")) {
        await askUserToReconnect(event.target?.mailboxEmail);
      } else {
        await alertOps("webhook needs attention", event);
      }
    },
  },
},

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?