Skip to Content

The EventWebhookEvent type of the TypeScript SDK, part of EventWebhookPayload.

type EventWebhookEvent = {
  actor: EventWebhookActor
  data?: unknown
  seq?: number
  ts: number
  type: string
}

Fields

FieldTypeDescription
actorEventWebhookActor
dataunknownOptional. Event-specific identifiers (message id, label name, state tokens, ...), never message content. A state.changed event's data carries the current state token per type ({ Email, Mailbox, Thread, EmailDelivery }); its Email value is a valid since for GET /mailboxes/{mailboxId}/messages/changes
seqnumberOptional. Mailbox outbox sequence number: present on store events (message.new, message.updated, ...), absent on worker-tier events (email.relayed, webhook.test, ...). Strictly increasing per mailbox; a gap you did not observe means a batch you missed
tsnumberWhen the event happened, epoch seconds
typestringEvent name. The vocabulary is ADDITIVE and shared with the live WebSocket feed (GET /mailboxes/{mailboxId}/events): message.new, message.imported, message.updated, message.expunged, message.restored, message.purged, label.created, label.renamed, label.updated, label.deleted, label.expunged, label.messages_updated, query.messages_updated, trash.emptied, thread.merged, state.changed, email.relayed, email.failed, webhook.test, ... Treat an unrecognized type as a generic 'something changed' nudge, never as an error

Used in

EventWebhookPayload.

On this page