docs: add broadcast.chat.remove event to X Activity API - #471
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Docs PR opened: #472 I reworked the Sep 29 changelog entry for broadcast.chat.remove into bullets with relative links and Livestream API links. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
broadcast.chat.removeevent on the X Activity API. It is a private event requiring thebroadcast.readscope (same asbroadcast.chat) and fires when a chat message is removed by the host or a moderator. The payload carriesbroadcast_idandmessage_id.Changes
x-api/activity/introduction.mdx— new row in the Broadcast events table, updated privacy note, and added to the private events list.x-api/activity/event-payloads.mdx— newbroadcast.chat.removesection with a sample delivery (reuses thebroadcast_id/message_idfrom thebroadcast.chatsample so the two read as one message being sent and then removed); description/keywords updated.livestream-api/chat/accessing-live-chat.mdx— new "Step 4: Receive removed-message events" section with a sample payload.livestream-api/chat/delete-chat-message.mdx— notes that deleting a message firesbroadcast.chat.removeand links to the new step.changelog.mdx— Sep 29, 2026 entry.Verification
mintlify devruns clean; all five pages render in the browser./x-api/activity/event-payloads#broadcast-chat-remove(linked from the changelog) and/livestream-api/chat/accessing-live-chat#step-4-receive-removed-message-events(linked from the Delete page).