Skip to main content
WEBHOOK
webhookEvent
{
  "type": "<string>",
  "userID": "<string>",
  "event": {
    "Info": {
      "ID": "<string>",
      "Chat": "<string>",
      "Sender": "<string>",
      "PushName": "<string>",
      "Timestamp": "2023-11-07T05:31:56Z",
      "IsFromMe": true,
      "IsGroup": true,
      "Type": "<string>"
    },
    "Message": {
      "conversation": "<string>",
      "imageMessage": {
        "caption": "<string>",
        "url": "<string>",
        "mimetype": "<string>"
      },
      "videoMessage": {},
      "audioMessage": {},
      "documentMessage": {},
      "extendedTextMessage": {
        "text": "<string>",
        "contextInfo": {}
      }
    }
  },
  "instanceName": "<string>",
  "jsonData": "<string>",
  "base64": "<string>",
  "mimeType": "<string>",
  "fileName": "<string>",
  "s3": {
    "bucket": "<string>",
    "key": "<string>",
    "url": "<string>"
  }
}

Body

application/json
​
type
string
required

The type of the event

Allowed value: "Message"
​
userID
string
required

The internal User ID associated with this instance

​
event
object
required
​
instanceName
string

Name of the WazzAPI instance (if configured)

​
jsonData
string

Stringified JSON of the event data

​
base64
string

Base64 encoded media data (optional)

​
mimeType
string

MIME type of the media (optional)

​
fileName
string

Filename of the media (optional)

​
s3
object

S3 storage details if enabled

Response

200

Event processed successfully