A new thread message (Hedge's or yours), pushed to your endpoint
Hedge POSTs this message whenever a new message becomes visible
on a submission’s thread; the SAME object, vocabulary and
visibility rules as GET /broker/submissions/{submission_id}/thread
(Hedge’s emails to your brokerage, your replies, and assistant
chat in both directions; never carrier or insured correspondence),
delivered within about a minute of becoming visible. One message
per delivery; a burst arrives as consecutive deliveries in order.
An endpoint receives messages from its creation onward (and, for
endpoints that predate this message type, from the moment it
shipped); history is not replayed.
Signing, svix-id dedupe, at-least-once delivery, in-order
delivery within a submission, acknowledgement and retry rules are
exactly those of submission.events. Messages never re-arrive
with a changed body; dedupe on svix-id (or on message.id).
Delivered to endpoints whose event_types filter is empty or
includes message.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
One broker-facing message on a submission, normalized across
channels. direction is relative to Hedge: inbound = your
brokerage wrote it (an email reply, or a message sent through
POST .../thread or the portal assistant), outbound = Hedge
wrote it. channel is email for emails Hedge exchanged with
your brokerage and chat for assistant-chat rows; from/to
are email addresses and are null/empty on chat rows.
object
The email’s type (e.g. initial_clearance, market_plan_update, quote_delivery, broker_reply) or chat.
Plain text. HTML-only emails are converted server-side.
object
Present when the file is a finalized document you can fetch via GET /broker/finalized-documents/{document_id}/pdf (relative to the base URL).
RFC 5322 Message-ID this email replied to, when known.
Responses
Section titled “Responses”Acknowledge with any 2xx within 10 seconds; response body is ignored.