Actions21
- Add Chat State
- Close Chat
- Collect Input
- Go To Step
- Go To Substep
- Mark Read & Show Typing
- Register Disposition
- Register Transaction
- Request Human
- Send Button
- Send Catalog Message
- Send Document
- Send List
- Send Product Carousel
- Send Product List
- Send Single Product Message
- Send Text
- Send WhatsApp Flow
- Set Flow State
- Start Survey
- Transfer Department
Set Flow State
AI-generatedSummary
Merges the supplied JSON patch into the chat session’s flow state by sending a SET_FLOW_STATE action to the RAW callback endpoint. Provide the client and chat IDs plus the patch; the callback URL defaults to the incoming item’s meta.callbackUrl in automatic mode.
Inputs
- Callback URL / Environment (required) — For version 1, Callback URL is required and defaults to
$json.meta.callbackUrl. For version 2+, choose Automatic (uses the input item’smeta.callbackUrl), Homologação, Produção, or Custom; Custom requires a callback URL. - Client ID (required) — Identifies the RAW client; defaults to
$json.meta.clientId. - Chat ID (required) — Identifies the chat whose flow state to update; defaults to
$json.meta.chatId. - Bot ID — Optional bot identifier. When provided, it is included in the callback request.
- Next Step — Optional step value included with the action request; it updates the session step without navigating to it.
- Next Sub Step — Optional substep value included in the request’s state.
- State Patch (JSON) (required) — JSON object sent as the
patchfor theSET_FLOW_STATEaction, for example{"key":"value"}. Invalid JSON is treated as an empty object.
Output shape
One output item per input item, containing { ok: true, operation, response } on success.
The operation sends a POST request to the resolved callback URL. If Continue On Fail is enabled, failed items instead contain
{ error }; otherwise an error is thrown.