/ Docs
Webhook Payloads

Status Update Payload

Page Tools
WEBHOOKStatus V1 · Smobi → Your Server

Status events report message processing and delivery outcomes. Use smobiMessageId and clientRef to associate an update with the original request.

Smobi sends these payloads to your configured HTTPS receiver. These are outbound events, not callable endpoints on api.smobi.com. Configure Webhooks.

Payload Fields

application/json
smobiMessageIdstringrequired

The reference number of the message in the Smobi system

clientRefstringrequired

The reference number of the message in the client system

tostringrequired

The phone number of the recipient

fromstringrequired

The phone number of the sender

statusstringrequired

The status of the message

Allowed values"PROCESSING""SENT""FAILED""DELIVERED""READ"
channelstringrequired

The channel of the message

Allowed values"SMS""RCS"
timestampstringrequired

The timestamp of the status update

Additional details about the status (for failed messages)

Show child fieldsHide child fields for payload.failureDetails
reasonstringrequired

The reason for the status

Allowed values"REJECTED""OPTED_OUT""UNDELIVERABLE"

The description of the status reason

Receiver Requirements

  • Validate the authentication headers configured for your receiver.
  • Persist or enqueue each accepted event before returning a successful 2xx response.
  • Handle repeated events and out-of-order status updates.