Webhooks

message.sent

A message was sent from a mailbox, from any app or the API.

Pro and Business plans. message_id is the message's permanent id: pass it to GET /mailboxes/{address}/messages/{uid} (and the flag, move, spam, delete and attachment routes) in place of a UID. It does not change when the message moves folder.

Partner endpoints receive this only for customers where you hold a mailbox key with mail:read, and as a pointer (mailbox, message_id, thread_id, folder, received_at): fetch the message with that key.

postWebhookmessage.sent

Headers

X-Faivelo-Signaturestring required

t=<unix seconds>,v1=<hex hmac>. Two v1 values for 24 hours after you rotate the secret; either one verifying is enough.

Payload

idstring required

Unique per event, stable across retries and resends.

typestring required

created_atstring date-time required

customer_idstring

Partner endpoints only: the customer the event belongs to.

dataobject required

Depends on type. See the example.

Example payload

{
  "id": "evt_01J8ZK3V5QXR7"
}

Response

Received. Any other answer, or none within 10 seconds, is retried.

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.