Skip to Content

The EventWebhook type of the TypeScript SDK, which domains.getEventWebhook and 3 more methods take or answer.

type EventWebhook = {
  consecutiveFailures: number
  createdAt: number
  degraded?: boolean
  disabledReason: string | null
  domain?: string
  enabled: boolean
  failingSince: number | null
  hasSecret: boolean
  lastDeliveredAt: number | null
  lastFailure: string | null
  lastFailureAt: number | null
  mailboxId?: string
  retryAfter?: number | null
  scope: ('mailbox' | 'domain')
  updatedAt: number
  url: string
}

Fields

FieldTypeDescription
consecutiveFailuresnumberConsecutive delivery failures; reset by any success or PUT
createdAtnumberCreation timestamp in epoch seconds
degradedbooleanOptional. Platform domains only: true while attempts above the hook's supported rate are queued on their retry ladder (never dropped). The health fields of a platform hook are a projection published at a fixed cadence of about a minute
disabledReasonstring | null'failing' after the 24h auto-disable; any PUT re-enables
domainstringOptional. Present on the domain scope
enabledboolean
failingSincenumber | nullWhen the current failing streak began, epoch seconds
hasSecretbooleanWhether a signing secret is set (write-only)
lastDeliveredAtnumber | nullLast successful delivery, epoch seconds
lastFailurestring | null
lastFailureAtnumber | nullLast failed delivery, epoch seconds
mailboxIdstringOptional. Present on the mailbox scope
retryAfternumber | nullOptional. Platform domains only: when the degraded hook has room again, epoch seconds
scope('mailbox' | 'domain')
updatedAtnumberLast update timestamp in epoch seconds
urlstring

Used by

MethodWhat it does
domains.getEventWebhookRead the domain's event webhook
domains.setEventWebhookCreate or replace the domain's event webhook
mailboxes.getEventWebhookRead the mailbox's event webhook
mailboxes.setEventWebhookCreate or replace the mailbox's event webhook

Used in

CreatedIdentity.