Skip to content

docs: update wait-for-event shapes - #1572

Merged
emisilvacab merged 1 commit into
mainfrom
docs-update-wait-for-event-shapes
Jul 31, 2026
Merged

docs: update wait-for-event shapes#1572
emisilvacab merged 1 commit into
mainfrom
docs-update-wait-for-event-shapes

Conversation

@emisilvacab

Copy link
Copy Markdown
Contributor

Description

Brings the wait for event docs in line with the current switchboard signal shapes and dashboard UX:

  • Integration source payload — Source event fields live under event.data.*, with envelope fields (user_id, inserted_at, preprocess_output, event_gid) at the top level.
  • Message events — Documents the Channel steps filter (workflow/broadcast), and adds missing fields: channel_type, channel_provider, tenant_id, exec_mode, step_ref.
  • Workflow events — Adds tenant_id, notify_data, exec_mode.
  • Match conditions — Notes automatic recipient scoping, and that selecting a channel step satisfies the required match condition for message events.

@vercel

vercel Bot commented Jul 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 29, 2026 4:42pm

Request Review

@emisilvacab
emisilvacab force-pushed the docs-update-wait-for-event-shapes branch from 80a85b9 to d3a4438 Compare July 29, 2026 16:36
@emisilvacab
emisilvacab requested a review from cjbell July 29, 2026 16:36

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 .mdx content 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_ref match condition behavior described for channel steps should be validated against the product
  • The change from signal_variables.status to signal_variables.data.status in the code example is a breaking documentation change — confirm this matches the actual payload structure
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

@emisilvacab
emisilvacab merged commit baec4c6 into main Jul 31, 2026
5 checks passed
@emisilvacab
emisilvacab deleted the docs-update-wait-for-event-shapes branch July 31, 2026 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants