Skip to main content
WEBHOOK
message-scheduled
{
  "event": "message.notification.scheduled",
  "data": {
    "id": "9e081e22-94ef-41d3-b8f2-cab2db1a030f",
    "request_id": "133554b5-ae44-44a0-8f4f-7bbac5657a11",
    "phone": {
      "id": "9defcf1e-552c-4bef-a843-872edec576ef",
      "user_id": "9cbff1d0-6c37-4612-a8bb-6db042991361",
      "phone_number": "+201479837429",
      "name": "john doe",
      "sim": "SIM1",
      "max_send_attempts": 10,
      "message_expiration_seconds": 259200,
      "missed_call_auto_reply_message": null,
      "is_online": true,
      "last_online_at": "2025-01-21 20:50:26",
      "last_offline_at": "2025-01-21 19:48:04",
      "last_message_at": "2025-01-22 19:51:23",
      "last_missed_call_at": null,
      "last_heartbeat_at": "2025-01-22 20:03:31",
      "heartbeat_enabled_at": "2025-01-21 20:50:26",
      "timezone": "GMT+2",
      "created_at": "2025-01-10 18:16:16",
      "updated_at": "2025-01-22 20:03:31"
    },
    "message_thread_id": "9e0631d1-203e-468c-a34b-6026ea43b6b8",
    "phone_id": "9defcf1e-552c-4bef-a843-872edec576ef",
    "from_phone_number": "+201478927398",
    "to_phone_number": "+201891838278",
    "content": "test message scheduled",
    "send_duration": null,
    "schedule_on_phone_at": null,
    "sent_at": null,
    "last_attempted_at": "2025-01-22 20:17:05",
    "delivered_at": null,
    "received_at": null,
    "expired_at": null,
    "schedule_send_at": "2025-01-22 20:20:00",
    "failed_at": null,
    "send_attempt_count": null,
    "max_send_attempts": 10,
    "failure_reason": null,
    "message_expiration_seconds": 259200,
    "timezone": "GMT+2",
    "sim": "SIM1",
    "status": "scheduled",
    "type": "sent_to_mobile",
    "created_at": "2025-01-22 20:17:05",
    "updated_at": "2025-01-22 20:17:05"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypersender.com/llms.txt

Use this file to discover all available pages before exploring further.

This webhook is triggered when the message is scheduled to be sent at a later time.

Headers

​
x-userId
string
required

User UUID associated with the connected WhatsApp instance.

​
x-instanceId
string
required

Instance UUID of the connected WhatsApp instance.

Body

application/json
​
event
enum<string>
required
Available options:
message.notification.scheduled
​
data
object
required

Response

200

Successfully received the message. The server acknowledged the information and returned status 200, indicating successful data reception.