-
Notifications
You must be signed in to change notification settings - Fork 6
docs: document sandbox mode and skip delays for the workflow test runner #1506
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cjbell
wants to merge
2
commits into
main
Choose a base branch
from
cjbell/test-runner-sandbox-skip-delay
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+32
−0
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -24,6 +24,7 @@ Learn more about triggering workflows in [our API reference](/api-reference/work | |||||
| | data | map | A map of properties that are required in the templates in this workflow | | ||||||
| | cancellation_key | string | A unique identifier to reference the workflow when canceling | | ||||||
| | tenant | string | An optional identifier of the owning tenant object for the notifications generated during this workflow run | | ||||||
| | settings | map | An optional map of settings that control how this workflow run is executed | | ||||||
|
|
||||||
| ## Recipient identifiers | ||||||
|
|
||||||
|
|
@@ -207,6 +208,28 @@ tenants to which they belong in your product. | |||||
|
|
||||||
| You can read more about [supporting multi-tenancy in our documentation](/concepts/tenants). | ||||||
|
|
||||||
| ## Controlling trigger behavior with settings | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wondering if we should update the title? Unclear if the
Suggested change
|
||||||
|
|
||||||
| You can pass an optional `settings` object in your `trigger` call to control how the workflow run is executed. These settings are useful when testing a workflow, and mirror the options available in the [workflow test runner](/send-notifications/testing-workflows#test-run-settings). | ||||||
|
|
||||||
| | Property | Type | Description | | ||||||
| | ------------ | ------- | ------------------------------------------------------------------------------------------------------------ | | ||||||
| | sandbox_mode | boolean | When `true`, all messages in the workflow run are forced to send in [sandbox mode](/integrations/overview#sandbox-mode), overriding the per-channel configuration. Messages are generated but not delivered to the underlying providers. Defaults to `false`. | | ||||||
| | skip_delay | boolean | When `true`, all [delay steps](/designing-workflows/delay-function) in the workflow are force skipped, so the run executes straight through without waiting. Defaults to `false`. | | ||||||
|
|
||||||
| ```json title="Example trigger with settings" | ||||||
| { | ||||||
| "recipients": ["user-1"], | ||||||
| "data": { | ||||||
| "message": "Life finds a way" | ||||||
| }, | ||||||
| "settings": { | ||||||
| "sandbox_mode": true, | ||||||
| "skip_delay": true | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ## Frequently asked questions | ||||||
|
|
||||||
| <AccordionGroup> | ||||||
|
|
||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
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)