Skip to content

Commit 981315c

Browse files
mintlify[bot]tcaldwell-x
authored andcommitted
docs: add is_subscriber field to broadcast.chat sample payload
1 parent 24f3712 commit 981315c

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

‎x-api/activity/event-payloads.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2210,7 +2210,7 @@ Fired when a user ends a live broadcast. Public event — can be subscribed to w
22102210

22112211
### `broadcast.chat`
22122212

2213-
Fired when the filtered user receives a chat message in a broadcast that they own. Private event — requires user-context authentication with the `broadcast.read` scope. The `payload` includes the `broadcast_id`, the chat `message_id` and `message` text, and an `author` block with the sending user's profile.
2213+
Fired when the filtered user receives a chat message in a broadcast that they own. Private event — requires user-context authentication with the `broadcast.read` scope. The `payload` includes the `broadcast_id`, the chat `message_id` and `message` text, an `is_subscriber` boolean, and an `author` block with the sending user's profile.
22142214

22152215
```json title="broadcast.chat" expandable lines wrap icon="/icons/xds/icon-brackets.svg"
22162216
{
@@ -2225,6 +2225,7 @@ Fired when the filtered user receives a chat message in a broadcast that they ow
22252225
"broadcast_id": "1mGPaZaAdNqJN",
22262226
"message_id": "2090000000000000004",
22272227
"message": "test",
2228+
"is_subscriber": false,
22282229
"author": {
22292230
"data": {
22302231
"affiliation": {

0 commit comments

Comments
 (0)