Skip to navigation

Message Received

Headers

svix-idstringRequired
ID of webhook message.
svix-signaturestringRequired
Signature of webhook message.
svix-timestampdatetimeRequired
Timestamp of webhook message.

Payload

The payload of this webhook request is an object.
type"event"Required
event_typeenumRequired
Allowed values:
event_idstringRequired

ID of the event. It is the same on every retry and redelivery of the event and on every webhook or WebSocket subscription that receives it, so use it to deduplicate. The format varies by event type; treat it as an opaque string.

messageobjectRequired

The received message. The body (text, html, extracted_text, and extracted_html) is included inline only when it is small enough. Webhooks omit it when the stored body is larger than 64 KiB; WebSocket events also omit it when the serialized event would be larger than 30 KiB. When the body is omitted, body_url and body_expires_at are set instead.

threadobjectRequired

Response

200
any
Return a 200 status to indicate that the data was received successfully.