Events and webhooks

Planned

Your code cannot receive events yet: there is no webhook to register and no socket to subscribe to. This page describes what they will carry.

Webhooks will be signed deliveries of these events, with retries and a delivery log, on Scale and up. The hosted event stream will carry the same events over a socket.

Event	Fires when
worker.paired	A device is added to the account
worker.connected	A device comes online
worker.disconnected	A device goes offline
worker.removed	A device is removed from the account
inbox.created	An email address is created
inbox.assigned	An email address is assigned to a device
inbox.removed	An email address is unassigned from a device
message.received	Mail arrives for an email address on the account
subscription.updated	The account’s plan changes

Each event is { "type": …, "payload": … }. Payloads carry ids, never content: to show a message, fetch it by id and decrypt it in your client.

{
  "type": "message.received",
  "payload": { "messageId": "msg_91be", "inboxId": "ibx_4c7a" }
}

Signing and delivery guarantees will be documented here when webhooks ship.