diff --git a/events/event-types.md b/events/event-types.md index bf3a5fe..941ec2a 100644 --- a/events/event-types.md +++ b/events/event-types.md @@ -7,11 +7,13 @@ description: Request body payloads for Webhook API requests ## Chat Message -```json +No identity for broadcasters at the moment. +``` Headers - Kick-Event-Type: “chat.message.sent” - Kick-Event-Version: “1” - +``` +```json { "message_id": "unique_message_id_123", "broadcaster": { @@ -21,7 +23,7 @@ Headers "is_verified": true, "profile_picture": "https://example.com/broadcaster_avatar.jpg", "channel_slug": "broadcaster_channel", - "identity": null // no identity for broadcasters at the moment + "identity": null }, "sender": { "is_anonymous": false, @@ -35,17 +37,17 @@ Headers "badges": [ { "text": "Moderator", - "type": "moderator", + "type": "moderator" }, { "text": "Sub Gifter", "type": "sub_gifter", - "count": 5, + "count": 5 }, { "text": "Subscriber", "type": "subscriber", - "count": 3, + "count": 3 } ] } @@ -71,11 +73,12 @@ Headers ## Channel Follow -```json +``` Headers - Kick-Event-Type: “channel.followed” - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -100,11 +103,12 @@ Headers ## Channel Subscription Renewal -```json +``` Headers - Kick-Event-Type: “channel.subscription.renewal” - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -132,12 +136,13 @@ Headers ## Channel Subscription Gifts -```json +Fields in `gifter` are null if the gifter is anonymous (`gifter.is_anonymous`). +``` Headers - Kick-Event-Type: “channel.subscription.gifts” - Kick-Event-Version: “1” - -Public Gift Structure +``` +```json { "broadcaster": { "is_anonymous": false, @@ -150,12 +155,12 @@ Public Gift Structure }, "gifter": { "is_anonymous": false, - "user_id": 987654321, // null if is_anonymous=true - "username": "gifter_name", // null if is_anonymous=true - "is_verified": false, // null if is_anonymous=true - "profile_picture": "https://example.com/sender_avatar.jpg", // null if is_anonymous=true - "channel_slug": "gifter_channel", // null if is_anonymous=true - "identity": null // null if is_anonymous=true + "user_id": 987654321, + "username": "gifter_name", + "is_verified": false, + "profile_picture": "https://example.com/sender_avatar.jpg", + "channel_slug": "gifter_channel", + "identity": null }, "giftees": [ @@ -176,11 +181,12 @@ Public Gift Structure ## Channel Subscription Created -```json +``` Headers - Kick-Event-Type: “channel.subscription.new” - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -209,11 +215,13 @@ Headers ## Livestream Status Updated #### Livestream Status Updated - Stream started -```json + +``` Headers - Kick-Event-Type: "livestream.status.updated" - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -232,11 +240,13 @@ Headers ``` #### Livestream Status Updated - Stream ended -```json + +``` Headers - Kick-Event-Type: "livestream.status.updated" - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -256,11 +266,12 @@ Headers ## Livestream Metadata Updated -```json +``` Headers - Kick-Event-Type: "livestream.metadata.updated" - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -286,11 +297,13 @@ Headers ## Moderation Banned -```json +`metadata.expires_at` is null if ban is permanent. +``` Headers - Kick-Event-Type: "moderation.banned" - Kick-Event-Version: “1” - +``` +```json { "broadcaster": { "is_anonymous": false, @@ -322,7 +335,7 @@ Headers "metadata": { "reason": "banned reason", "created_at": "2025-01-14T16:08:05Z", - "expires_at": "2025-01-14T16:10:06Z", // null for permanent bans + "expires_at": "2025-01-14T16:10:06Z" } } ``` \ No newline at end of file