docs: document sandbox mode and skip delays for the workflow test runner#1506
docs: document sandbox mode and skip delays for the workflow test runner#1506cjbell wants to merge 2 commits into
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ 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.
There was a problem hiding this comment.
Risk LOW: Documents sandbox mode and skip delays settings for the workflow test runner across two existing MDX pages.
Reasons
- Only two
.mdxcontent 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-settingsrenders correctly from the cross-reference intesting-workflows.mdx. - The PR description notes that
settings.skip_delayis not yet in the OpenAPI spec onmain, so the auto-generated API reference won't reflect it until the spec catches up — worth confirming that doesn't cause confusion for readers.
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 |
There was a problem hiding this comment.
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!
| ## 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 |
There was a problem hiding this comment.
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)



Description
Documents two new settings for the workflow test runner:
Both settings are also documented on the trigger API page via the
settings.sandbox_modeandsettings.skip_delayproperties, 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— addssettingsto the trigger payload table and a "Controlling trigger behavior with settings" section.Note:
settings.skip_delayis not yet present in the OpenAPI spec onmain(onlysandbox_modeis), so it won't render in the auto-generated API reference until the spec catches up.Tasks
Made with Cursor