chore: clarify batched data payload #1259
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| ### The `data` payload | ||
|
|
||
| When a workflow includes a batch step, the `data` payload that is available to your message templates after the batch window closes (and via the API, wherever trigger data is returned alongside a message or used as a [filter](/api-reference/overview/trigger-data-filtering)) will be combined and truncated according to the following rules: |
There was a problem hiding this comment.
I'm wondering if it would it make sense to split out the parenthetical, since this section is focused on using the data in templates? I like that you mention it (it's helpful info!) but wondering if it may fit better elsewhere?
There was a problem hiding this comment.
I'm open to other ideas on where to put this, the reason I included it here was to make the connection between the message templates/steps and the messages that they ultimately produce. I suppose we could say "...alongside the message" and that might make that connection clearer?
It's also included in the API ref under trigger data filtering but I thought it might be good to have somewhere on the batch function page since that's the case where it's relevant within the workflow run.
Description
This PR adds a section to the batch function page that provides guidance on what
datais available after a batch step.