Webhook Events

Email sent

A mail left through the email API. Exactly one event per mail, whichever path sent it: source is send, reply, forward, draft or scheduled. A scheduled draft carries both scheduleId and draftId.

Use it to record sends in your own system with the metadata you passed. The sent copy also arrives as message.sent in the inbox.

postWebhookemail.sent

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.sent' required
source'send' | 'reply' | 'forward' | 'draft' | 'scheduled' required
draftIdstring nullable

The draft it was sent from (source: draft, or a scheduled draft).

scheduleIdstring nullable

The scheduled send (source: scheduled).

replyToMessageIdstring nullable
forwardedFromstring nullable
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.