Webhook Events

Email updated

A message in the mailbox changed: it was read or marked unread, starred or flagged, labelled or categorized, archived, trashed or moved. Covers the Inbox, and Sent on Gmail. A change can arrive more than once; key on email.messageId.

Gmail reports exactly what changed in changes. Outlook reports the message as it is now, with changes: null. A message deleted for good fires email.deleted instead. IMAP mailboxes do not send it.

postWebhookemail.updated

Payload

idstring required
testboolean

Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.

event'email.updated' required
timestampstring date-time required

Example payload

{
  "profiles": [
    {
      "externalId": "tenant_42"
    }
  ]
}

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.