Create Event
Supported & TestedCreate and send a WhatsApp event message.
POSThttps://api.waplix.io/api/v1/messages/send-event
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| chat_id | string | Required | Required group/chat JID (number also accepted) |
| name | string | Required | Required event title |
| start_time | number | Required | Required Unix timestamp in seconds |
| description | string | Optional | Optional event details text description |
| location | string | Optional | Optional place location label |
| end_time | number | Optional | Optional Unix end timestamp in seconds |
instance_id
stringReq Required Waplix instance id
chat_id
stringReq Required group/chat JID (number also accepted)
name
stringReq Required event title
start_time
numberReq Required Unix timestamp in seconds
description
stringOpt Optional event details text description
location
stringOpt Optional place location label
end_time
numberOpt Optional Unix end timestamp in seconds
Usage Notes
Verified on production. Public documentation uses sanitized example data only.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/messages/send-event" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"instance_id": "demo_instance",
"chat_id": "15551234567@s.whatsapp.net",
"name": "Waplix Conference",
"description": "API Docs integration kickoff call.",
"location": "Virtual Zoom Room",
"start_time": 1782585918,
"end_time": 1782589518
}'Success Response
Response · 200 OK
{
"success": true,
"data": {
"instance_id": "demo_instance",
"chat_id": "15551234567@s.whatsapp.net",
"message_id": "MSG_DEMO_001",
"status": "sent",
"name": "Waplix Conference",
"start_time": 1782585918,
"end_time": 1782589518
}
} Related Webhook Events
The API response confirms that Waplix accepted or processed the request. Delivery and read updates may arrive asynchronously through configured webhooks.
message.sent
Triggered when the event message is sent.
{
"event": "message.sent",
"instance_id": "demo_instance",
"chat_id": "15551234567@s.whatsapp.net",
"to": "15551234567@s.whatsapp.net",
"message_type": "event",
"message_id": "MSG_DEMO_001",
"name": "Waplix Conference",
"description": "API Docs integration kickoff call.",
"location": "Virtual Zoom Room",
"start_time": 1782585918,
"end_time": 1782589518,
"timestamp": 1782582319
} Was this page helpful?