docs: document pausing event streams#2617
Open
alnr wants to merge 1 commit into
Open
Conversation
Add a "Pause and resume event streams" section to the live event streams guide covering how to pause/resume a stream from the Ory Console, how to create a stream as paused, and what happens to events while a stream is paused. Most importantly, it explains the buffering behavior: while paused, events keep accumulating and are retained for up to 7 days. Resuming within that window delivers the buffered backlog; events older than 7 days are permanently discarded. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation to the Live event streams guide explaining how to pause/resume streams (Console + API), how to create streams in a paused state, and what happens to events during a pause (buffering/retention behavior).
Changes:
- Document pausing/resuming event streams via Ory Console and API status updates.
- Document creating an event stream with initial status
paused. - Explain buffering semantics while paused (up to 7 days), including delivery characteristics on resume and discard behavior after retention.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
shaunnkhan
approved these changes
Jun 9, 2026
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.
Documents the new ability to pause event streams, shipped in ory-corp/cloud#12238.
Adds a Pause and resume event streams section to the live event streams guide:
statusupdate).The 7-day figure matches the event streamer's Pub/Sub subscription retention (
RetentionDuration: 7 days); the explanation is written in vendor-neutral, user-facing terms.Implementation PR: ory-corp/cloud#12238