Skip to main content
WEBHOOK
newsletter
{
  "eventId": "evt_a1b2c3d4e5f67890",
  "instanceId": "ins_ABCdefGHIjk",
  "receivedAt": "2025-05-19T00:51:44.816Z",
  "eventType": "newsletter",
  "eventData": {
    "id": "1234567890@newsletter",
    "action": "join",
    "name": "My Channel",
    "role": "SUBSCRIBER"
  }
}

Body

application/json
​
eventId
string
required

Unique event identifier

​
instanceId
string
required

The ID of the WhatsApp instance that generated the event

​
receivedAt
string<date-time>
required

The timestamp when the event was received

​
eventType
enum<string>
required

The type of event

Available options:
newsletter
​
eventData
object
required

Response

200

Return a 200 status to indicate that the data was received successfully