-
Notifications
You must be signed in to change notification settings - Fork 0
/
websocket.schema.json
133 lines (133 loc) · 3.2 KB
/
websocket.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "StreamElements websocket widget schema",
"type": "object",
"properties": {
"_id": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"example": "1234567890abcdef12345678",
"description":"StreamElements hexadecimal Event ID"
},
"channel": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"example": "1234567890abcdef12345678",
"description":"StreamElements hexadecimal Channel ID"
},
"type": {
"enum": [
"cheer",
"follow",
"host",
"raid",
"subscriber",
"tip"
],
"description": "Event type"
},
"provider": {
"enum": [
"twitch",
"youtube",
"facebook"
],
"description": "Event provider"
},
"flagged": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"tipId": {
"type": "string",
"pattern": "^[a-f0-9]{24}$",
"example": "1234567890abcdef12345678",
"description":"StreamElements hexadecimal tip ID"
},
"username": {
"type": "string",
"description":"Twitch username",
"pattern":"^[a-z][a-z0-9_]{3,15}$"
},
"providerId": {
"type": "string",
"format":"number",
"description":"Twitch channel ID"
},
"displayName": {
"type": "string",
"description":"Twitch username case sensitive plus regional characters if provided"
},
"amount": {
"type": "integer",
"description":"Amount of currency in tip, months in subs, hosting/raiding viewers, bits in cheer"
},
"streak": {
"type": "integer",
"description":"Current months streak (subs only)"
},
"tier": {
"enum": [
"1000",
"2000",
"3000",
"prime"
],
"description": "Subscriber tier (subs only)"
},
"currency": {
"type": "string",
"pattern":"[A-Z]{3}",
"description":"Currency symbol (tips)"
},
"message": {
"type": "string",
"description":"User provided message"
},
"quantity": {
"type": "integer"
},
"items": {
"type": "array",
"items": {},
"description":"Redeemed items"
},
"avatar": {
"type": "string",
"format":"uri",
"description":"URI of user avatar"
}
},
"required": [
"username",
"displayName",
"amount",
"message",
"items",
"avatar"
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Event creation date and time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Event update date and time"
}
},
"required": [
"_id",
"channel",
"type",
"provider",
"flagged",
"data",
"createdAt",
"updatedAt"
]
}