# EventWebhook

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

```ts
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

| Field | Type | Description |
| --- | --- | --- |
| `consecutiveFailures` | `number` | Consecutive delivery failures; reset by any success or PUT |
| `createdAt` | `number` | Creation timestamp in epoch seconds |
| `degraded` | `boolean` | Optional. 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 |
| `disabledReason` | `string` \| `null` | 'failing' after the 24h auto-disable; any PUT re-enables |
| `domain` | `string` | Optional. Present on the domain scope |
| `enabled` | `boolean` |  |
| `failingSince` | `number` \| `null` | When the current failing streak began, epoch seconds |
| `hasSecret` | `boolean` | Whether a signing secret is set (write-only) |
| `lastDeliveredAt` | `number` \| `null` | Last successful delivery, epoch seconds |
| `lastFailure` | `string` \| `null` |  |
| `lastFailureAt` | `number` \| `null` | Last failed delivery, epoch seconds |
| `mailboxId` | `string` | Optional. Present on the mailbox scope |
| `retryAfter` | `number` \| `null` | Optional. Platform domains only: when the degraded hook has room again, epoch seconds |
| `scope` | `('mailbox' \| 'domain')` |  |
| `updatedAt` | `number` | Last update timestamp in epoch seconds |
| `url` | `string` |  |

## Used by

| Method | What it does |
| --- | --- |
| [`domains.getEventWebhook`](/docs/sdks/typescript/domains/get-event-webhook) | Read the domain's event webhook |
| [`domains.setEventWebhook`](/docs/sdks/typescript/domains/set-event-webhook) | Create or replace the domain's event webhook |
| [`mailboxes.getEventWebhook`](/docs/sdks/typescript/mailboxes/get-event-webhook) | Read the mailbox's event webhook |
| [`mailboxes.setEventWebhook`](/docs/sdks/typescript/mailboxes/set-event-webhook) | Create or replace the mailbox's event webhook |

## Used in

[`CreatedIdentity`](/docs/sdks/typescript/types/created-identity).
