Skip to navigation

Inbound message received

View as Markdown

Delivered to the inboundWebhookUrl you set with POST /settings/webhooks when a contact sends a message to one of your agents. Verify X-MB-Signature against the raw request bytes before trusting the payload.

Payload

The payload of this webhook request is an object.
typeenumOptional
Allowed values:
messageIdstringOptional
textstring or nullOptional
fromstring or nullOptional

Sender handle (E.164 phone or email), canonicalized.

tostring or nullOptional
outboundbooleanOptional
iMessageNumberstring or nullOptional
The agent number that received it.
participantslist of strings or nullOptional
chatGuidstring or nullOptional
groupIdstring or nullOptional
messageGuidstring or nullOptional
attachmentslist of stringsOptional
timestamp_mslongOptional
accountIdstring or nullOptional

Response

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