Waplix
Docs

Webhooks Configuration

Supported & Tested

Get and save active webhooks configuration settings, target URL receiver, and event subscriptions.

GEThttps://api.waplix.io/api/v1/webhooks?instance_id=12345
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
instance_id
stringReq

Required Waplix instance id

Usage Notes
Verified on production. Public documentation uses sanitized example data.
Request Payload Example
Request 
curl -X GET "https://api.waplix.io/api/v1/webhooks?instance_id=12345" \
  -H "Authorization: Bearer YOUR_API_KEY"
Success Response
Response · 200 OK
{
  "success": true,
  "instance_id": "demo_instance",
  "webhook_url": "https://example.com/webhook",
  "events": [
    "message.received",
    "message.delivered",
    "message.read",
    "chat.archived",
    "label.chat.updated"
  ]
}
POSThttps://api.waplix.io/api/v1/webhooks
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
instance_id
stringReq

Required Waplix instance id

webhook_url
stringReq

Required target HTTPS webhook receiver URL

events
arrayReq

Array of subscribed event names

Usage Notes
Supported event names include message_create, message_ack, message.received, message.sent, message.delivered, message.read, and message.played.
Request Payload Example
Request 
curl -X POST "https://api.waplix.io/api/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instance_id": "demo_instance",
  "webhook_url": "https://example.com/webhook",
  "events": [
    "message_create",
    "message_ack"
  ]
}'
Success Response
Response · 200 OK
{
  "success": true,
  "message": "Webhook settings saved successfully"
}
Previous IntroductionNext Logs
Was this page helpful?