docs: update wait-for-event shapes - #1572
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
emisilvacab
force-pushed
the
docs-update-wait-for-event-shapes
branch
from
July 29, 2026 16:36
80a85b9 to
d3a4438
Compare
There was a problem hiding this comment.
Risk LOW: Updates event shape documentation for the wait-for-event function, expanding field references and adding clarifying notes about channel steps and match conditions.
Reasons
- Only a single
.mdxcontent file is modified (content/designing-workflows/wait-for-event-function.mdx) - Small diff with 20 additions and 12 deletions (32 total lines changed)
- No new pages, sidebar changes, or component modifications
- Changes are documentation-only: updating event field tables and adding descriptive text
- Author is a known team member with multiple prior merged contributions referencing internal Knock tickets
Notes
- Reviewers should verify the updated
event.*field tables accurately reflect the current API event shapes - The new
event.step_refmatch condition behavior described for channel steps should be validated against the product - The change from
signal_variables.statustosignal_variables.data.statusin the code example is a breaking documentation change — confirm this matches the actual payload structure
Sent by Cursor Automation: Docs PR classifier
cjbell
approved these changes
Jul 31, 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.


Description
Brings the wait for event docs in line with the current switchboard signal shapes and dashboard UX:
event.data.*, with envelope fields (user_id, inserted_at, preprocess_output, event_gid) at the top level.