Skip to main content

Suggestion Event

Suggestion Event callbacks are triggered to notify your application that a user has performed a suggested action. These callbacks provide detailed information, including the message ID, recipient, and timestamps.

Note: all suggestion types that are billable (REPLY and REQUEST_LOCATION) generate MOs instead.

Suggestion Webhook Payload

ParameterTypeRequiredDescriptionExample
typestringtrueAlways SUGGESTIONSUGGESTION
directionstringtrueAlways OutboundOutbound
channelstringtrueAlways rcsrcs
message_idstringtrueID of message4de1d075-2a7e-404e-abac-3f80560db42f
tostringfalseThe sender the message was sent toexampleSender
fromstringfalseThe phone number the message was sent from (E164 format with no plus)1987654321
tagstringfalseCustom defined string sent with messageexample tag
bulk_tagstringfalseCustom defined string sent with messageexample bulk tag
event_metaobjecttrueEvent specific metadata{ "text": "Yes", "callback_data": "exampleCallback" }
event_meta.textstringtrueThe text of the suggestionYes
event_meta.callback_datastringtrueCustom defined string sent with the messageexampleCallback
errorobjecttrueThe message error, if applicable{ "code": "0", "description": "None" }
error.codestringtrueDetailed error code0
error.descriptionstringtrueDetailed error descriptionno error
timestringtrueThe time of the event was received in ISO 8601 format2025-12-01T15:30:00Z
api_versionstringtrueThe version of the API the message was sent on1