Skip to content

Commit 4ba60ce

Browse files
committed
Add channel activity and session update payloads to WebSocket documentation
1 parent 7788d85 commit 4ba60ce

6 files changed

Lines changed: 40 additions & 2 deletions

File tree

docs/websockets/topics/channel-activities.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,26 @@ This event is fired when the channel received a new activity.
1515
#### Payload
1616

1717
```json
18-
{}
18+
{
19+
"id": "01HPPM2TQ6CCMFQGHEN8MM1NN0",
20+
"ts": "2024-02-15T14:52:42Z",
21+
"type": "message",
22+
"topic": "channel.activities",
23+
"data": {
24+
"type": "follow",
25+
"provider": "twitch",
26+
"channel": "6183c7d4ebc632abbf809890",
27+
"data": {
28+
"username": "jtv",
29+
"displayName": "jtv",
30+
"providerId": "14027",
31+
"avatar": "https://static-cdn.jtvnw.net/user-default-pictures-uv/13e5fa74-defa-11e9-809c-784f43822e80-profile_image-300x300.png"
32+
},
33+
"_id": "65ce2539b1585c5f909a91e1",
34+
"createdAt": "2024-02-15T14:52:41.608Z",
35+
"updatedAt": "2024-02-15T14:52:41.608Z",
36+
"activityId": "65ce2539b1585c5f909a91e1",
37+
"sessionEventsCount": 6
38+
}
39+
}
1940
```

docs/websockets/topics/channel-session-update.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,18 @@ This event is fired when the channel received a new activity.
1414
#### Payload
1515

1616
```json
17-
{}
17+
{
18+
"id": "01HPPM2TQ6CCMFQGHENAPFR4ZE",
19+
"ts": "2024-02-15T14:52:42Z",
20+
"type": "message",
21+
"topic": "channel.session.updates",
22+
"data": {
23+
"name": "follower-goal",
24+
"provider": "twitch",
25+
"data": {
26+
"amount": 70,
27+
"activityId": "65ce2539b1585c5f909a91e1"
28+
}
29+
}
30+
}
1831
```

docs/websockets/topics/chatbot/chatbot-status.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This event is triggered whenever there is a change in the chatbot's status. It s
1515
"id": "01HNX3Q5CS8D309V6DXJ3ZADEQ",
1616
"ts": "2024-02-05T17:05:41Z",
1717
"topic": "channel.chatbot.status",
18+
"type":"message",
1819
"data": {
1920
"mod": true
2021
}

docs/websockets/topics/chatbot/modules-emotecombo.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This event is triggered when a user sucessfully completes a pyramid in chat.
1515
"id": "01HNX3Q5CS8D309V6DXJ3ZADEQ",
1616
"ts": "2024-02-05T17:05:41Z",
1717
"topic": "channel.chatbot.modules.emotecombo",
18+
"type":"message",
1819
"data": {
1920
"msg_id": "f71ef587-bf91-4f68-ae21-480ff03c0bf8",
2021
"user_id": "94055225",

docs/websockets/topics/chatbot/modules-pyramid.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This event is triggered when a user sucessfully completes a pyramid in chat.
1515
"id": "01HNX3Q5CS8D309V6DXJ3ZADEQ",
1616
"ts": "2024-02-05T17:05:41Z",
1717
"topic": "channel.chatbot.modules.pyramid",
18+
"type":"message",
1819
"data": {
1920
"msg_id": "f71ef587-bf91-4f68-ae21-480ff03c0bf8",
2021
"user_id": "94055225",

docs/websockets/topics/chatbot/timeout.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ When the chatbot times someone out.
1919
"id": "01HNX3Q5CS8D309V6DXJ3ZADEQ",
2020
"ts": "2024-02-05T17:05:41Z",
2121
"topic": "channel.chatbot.status",
22+
"type":"message",
2223
"data": {
2324
"msg_id": "f71ef587-bf91-4f68-ae21-480ff03c0bf8",
2425
"user_id": "94055225",

0 commit comments

Comments
 (0)