Skip to main content
WEBHOOK
Event: message.phone.ussd Sent when the phone gets a USSD or flash reply linked to a message you sent, for example a balance notice from the carrier. The reply text is in ussd_message. The message keeps its current status.

Headers

x-hypersender-event
string
required

The event name. Same as event in the body.

x-hypersender-delivery
string
required

Unique ID of this delivery attempt. A retry gets a new value, so do not use it to find duplicates.

x-instance-id
string
required

Instance ID of the SMS instance the event belongs to.

x-user-id
string
required

Your Hypersender user ID.

x-api-version
string
required

Webhook format version.

Authorization
string

Only sent when you set an Authorization Secret on the webhook. The value is your secret, exactly as you saved it. Compare it with a constant-time check.

Body

application/json
event
enum<string>
required
Available options:
message.phone.ussd
data
object
required

Response

200

Return any 2xx status to acknowledge the event.

Last modified on November 20, 2026