Skip to navigation
RCSWebhooks

Inbound message

Notification of free-form content the user sends without linking it to a specific suggestion, within the ttl_events window of the last message sent to that number. If the window already expired, the event is discarded and not notified.

The root message_id identifies the inbound message (not the outbound send); data.related_message_id points to the message_id of the most recent outbound message the conversation is associated with. The data.message object carries the canonical content and its shape depends on type: TEXT (text), FILE (url, mime_type, file_name — the file is already re-hosted in Chat Bridge storage, not the user’s original), or LOCATION (latitude, longitude).

Payload

The payload of this webhook request is an object.
originenumOptional

Origin of the message: direct API send (API) or bulk campaign send (CAMPAIGN).

Allowed values:
channelenumOptional

RCS channel of the send, according to the type of the agent/template used.

Allowed values:
message_idstringOptional

Identifier of the INBOUND message (not the outbound send). The related send travels in data.related_message_id.

statusenumOptional

Forced to DELIVERED; data.action is always REPLY.

Allowed values:
occurred_atdatetimeOptional
Moment of the event.
timestampstringOptional

Moment of the event as epoch seconds (string). Redundant with occurred_at; use whichever you prefer.

campaign_idstringOptional

Optional. Only present when origin is CAMPAIGN and the message belongs to a campaign; omitted otherwise.

dataobjectOptional

Event-specific content; its shape depends on the event type.

Response

200
Event received by the client.