Webhook Payload
Below document will describe the details of a webhook message payload

Payload Fields

Field
Type
Description
messageID
string
The message ID from server side.
localID
string
The message ID from client side.
type
integer
The message type.
typeName
string
The message type name.
body
string
The content of the message.
data
string
The actual data payload for custom message type, in JSON string.
filterID
string
The filter ID.
isHidden
boolean
If the message should be hidden.
quote
object
Quoted message.
title
string
The quoted message's title.
content
string
The quoted message's content.
imageURL
string
Quoted image URL, if any.
fileID
string
Quoted file ID, if any.
fileType
string
Quoted file type, if any.
replyTo
object
Info of the replied source message.
userID
string
User ID of the replied message's sender.
xcUserID
string
The user ID from customer's server.
fullname
string
Full name of the original message's sender.
messageID
string
The replied message ID.
localID
string
The replied message's local ID.
Payload Example
1
{
2
"messageID": "130",
3
"localID": "ee9fa71d70d6",
4
"type": 1001,
5
"typeName": "text",
6
"body": "This is the body of the message",
7
"data": "",
8
"filterID": "",
9
"isHidden": false,
10
"quote": {
11
"title": "",
12
"content": "",
13
"imageURL": "",
14
"fileID": "",
15
"fileType": ""
16
},
17
"replyTo": {
18
"userID": "0",
19
"xcUserID": "",
20
"fullname": "",
21
"messageID": "0",
22
"localID": "",
23
"messageType": 0
24
},
25
"forwardFrom": {
26
"userID": "0",
27
"xcUserID": "",
28
"fullname": "",
29
"messageID": "0",
30
"localID": ""
31
},
32
"room": {
33
"roomID": "2-7",
34
"xcRoomID": "",
35
"name": "Macy Sanderson, John Doe",
36
"type": 1,
37
"imageURL": {
38
"thumbnail": "",
39
"fullsize": ""
40
},
41
"isLocked": false,
42
"lockedTime": 0,
43
"deleted": 0,
44
"isDeleted": false
45
},
46
"user": {
47
"userID": 7,
48
"xcUserID": "1",
49
"fullname": "John Doe",
50
"imageURL": {
51
"thumbnail": "https://www.example.com/photos/thumb/thumbnail.jpg",
52
"fullsize": "https://www.example.com/photos/full/fullsize.jpg"
53
}
54
},
55
"recipientID": "2",
56
"action": "",
57
"target": {
58
"targetType": "",
59
"targetID": "0",
60
"targetXCID": "",
61
"targetName": ""
62
},
63
"isDelivered": false,
64
"isRead": false,
65
"isDeleted": false,
66
"created": 1651067084218,
67
"updated": 1651067084218,
68
"deleted": 0
69
}
Copied!
Copy link