add docs for configuring webhook responses for Sync triggers#765
Merged
Conversation
7 tasks
midigofrank
force-pushed
the
configurable-webhook-responses
branch
from
15586b2 to
23fd97b
Compare
Collaborator
josephjclark
left a comment
josephjclark
left a comment
There was a problem hiding this comment.
Lovely, just a couple of comments
| system in one of two ways, depending on how the trigger is configured. | ||
|
|
||
| ### **Asynchronous mode** | ||
| ### **Async (Before Start)** |
Collaborator
There was a problem hiding this comment.
I see what you're getting at, but can I recommend the title is Async Mode Responds Before Start
Just because the raw option text doesn't really have enough context to make this make sense
| - Body: the final run state as a JSON object | ||
|
|
||
| **What this response includes:** | ||
| :::note Security policy for failed runs |
| } | ||
| } | ||
| ``` | ||
| In sync mode you can set custom HTTP status codes via the trigger inspector |
Collaborator
There was a problem hiding this comment.
Is "trigger inspector" clear? Do we use that language elsehwere?
Is it better to just say "set custom HTTP status codes on the trigger" ? That sort of covers the UI and CLI
| })); | ||
| ``` | ||
|
|
||
| `webhookResponse` is captured from each step as it completes, with **last write |
Collaborator
There was a problem hiding this comment.
This is a bit too technical. Although this might not be technically accurate, I think I'd say:
At the end of the run, the value of `state.webhookResponse` will be used to send the HTTP response back to the caller. Changing the value during the run does not affect the response: it's only the final state that counts.
josephjclark
approved these changes
May 19, 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
2 participants
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.
Short Description
add docs for configuring webhook responses for Sync triggers
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy