You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: x-api/activity/event-payloads.mdx
+114Lines changed: 114 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2044,6 +2044,120 @@ Fired when the filtered user unblocks another user.
2044
2044
2045
2045
## Broadcast events
2046
2046
2047
+
### `broadcast.start`
2048
+
2049
+
Fired when a user starts a live broadcast. Public event — can be subscribed to with either app-only or user-context authentication. The `payload` includes the host `user` and the `broadcast_id`.
Fired when a user ends a live broadcast. Public event — can be subscribed to with either app-only or user-context authentication. Same shape as `broadcast.start` with an inner `event_type` of `broadcast_end`.
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.
|`broadcast.start`| Fired when a user starts a live broadcast |`user_id`|
170
+
|`broadcast.end`| Fired when a user ends a live broadcast |`user_id`|
171
+
|`broadcast.chat`| Fired when the filtered user receives a chat message in a broadcast that they own |`user_id`|
170
172
171
173
<Note>
174
+
**Public events:**`broadcast.start` and `broadcast.end` are public events and can be subscribed to with either app-only or user-context authentication.
175
+
172
176
**Private event:**`broadcast.chat` is a private event and requires user-context (OAuth 2.0) authentication with the `broadcast.read` scope. See [Event privacy and authentication](#event-privacy-and-authentication) below.
173
177
</Note>
174
178
@@ -193,6 +197,7 @@ Public events are activities that a public user account performs publicly that a
0 commit comments