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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
type | string | true | Always SUGGESTION | SUGGESTION |
direction | string | true | Always Outbound | Outbound |
channel | string | true | Always rcs | rcs |
message_id | string | true | ID of message | 4de1d075-2a7e-404e-abac-3f80560db42f |
to | string | false | The sender the message was sent to | exampleSender |
from | string | false | The phone number the message was sent from (E164 format with no plus) | 1987654321 |
tag | string | false | Custom defined string sent with message | example tag |
bulk_tag | string | false | Custom defined string sent with message | example bulk tag |
event_meta | object | true | Event specific metadata | { "text": "Yes", "callback_data": "exampleCallback" } |
event_meta.text | string | true | The text of the suggestion | Yes |
event_meta.callback_data | string | true | Custom defined string sent with the message | exampleCallback |
error | object | true | The message error, if applicable | { "code": "0", "description": "None" } |
error.code | string | true | Detailed error code | 0 |
error.description | string | true | Detailed error description | no error |
time | string | true | The time of the event was received in ISO 8601 format | 2025-12-01T15:30:00Z |
api_version | string | true | The version of the API the message was sent on | 1 |