Skip to main content
WEBHOOK
Event: phone.logout Sent when the phone is logged out of the instance in the Hypersender SMS app. The phone stops sending and receiving messages for this instance until you link it again from the SMS quick start. data is the phone. id and phone_id are your Instance ID. After a logout, push_registration.status is missing and the instance waits for a new QR code scan. API requests for this instance return 403 until you link the phone again.

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:
phone.logout
data
object
required

Response

200

Return any 2xx status to acknowledge the event.

Last modified on November 20, 2026