Skip to content

docs: document sandbox mode and skip delays for the workflow test runner#1506

Open
cjbell wants to merge 2 commits into
mainfrom
cjbell/test-runner-sandbox-skip-delay
Open

docs: document sandbox mode and skip delays for the workflow test runner#1506
cjbell wants to merge 2 commits into
mainfrom
cjbell/test-runner-sandbox-skip-delay

Conversation

@cjbell

@cjbell cjbell commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Description

Documents two new settings for the workflow test runner:

  • Sandbox mode — when enabled, all messages sent from the workflow are forced to send in sandbox mode, generating and previewing messages without delivering them to the underlying providers.
  • Skip delays — when enabled, all delay steps in the workflow are force skipped, so the run executes straight through without waiting.

Both settings are also documented on the trigger API page via the settings.sandbox_mode and settings.skip_delay properties, which is useful when testing workflows programmatically.

Changes:

  • content/send-notifications/testing-workflows.mdx — adds a "Test run settings" section.
  • content/send-notifications/triggering-workflows/api.mdx — adds settings to the trigger payload table and a "Controlling trigger behavior with settings" section.

Note: settings.skip_delay is not yet present in the OpenAPI spec on main (only sandbox_mode is), so it won't render in the auto-generated API reference until the spec catches up.

Tasks

Made with Cursor

Add docs for the new test runner settings and the matching
settings.sandbox_mode and settings.skip_delay trigger options.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel

vercel Bot commented Jun 25, 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 Jun 26, 2026 10:11pm

Request Review

@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.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit c9e8dd3. Configure here.

Comment thread content/send-notifications/testing-workflows.mdx
@cjbell cjbell marked this pull request as ready for review June 29, 2026 19:53

@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: Documents sandbox mode and skip delays settings for the workflow test runner across two existing MDX pages.

Reasons

  • Only two .mdx content files are modified — no code, components, or configuration changes.
  • Small, additive-only diff (32 additions, 0 deletions) well under the 50-line threshold.
  • Both files live in the same documentation section (content/send-notifications/), so no cross-section risk.
  • No new pages added — both files are modifications to existing docs.
  • No sidebar, OpenAPI spec, or image changes.

Notes

  • Reviewers may want to verify the anchor link #controlling-trigger-behavior-with-settings renders correctly from the cross-reference in testing-workflows.mdx.
  • The PR description notes that settings.skip_delay is not yet in the OpenAPI spec on main, so the auto-generated API reference won't reflect it until the spec catches up — worth confirming that doesn't cause confusion for readers.
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier


You can read more about [supporting multi-tenancy in our documentation](/concepts/tenants).

## Controlling trigger behavior with settings

@rachael-t rachael-t Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wondering if we should update the title? Unclear if the settings object might expand use cases in the future, but for now, since it's just scoped to testing I think we should make that more clear? Open to suggestions on this though!

Suggested change
## Controlling trigger behavior with settings
## Testing workflow triggers


After clicking "Run test," you will see a confirmation and a link to see the log to review the output and what was sent. You can learn more about Knock logs and the debugger [here](/send-notifications/debugging-workflows).

### Test run settings

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we move this to after the source event paragraph and before the callout? It feels a bit disjointed being inserted into this existing section (curious what others think)

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