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
Register Disposition
AI-generatedSummary
Registers a disposition for the specified chat by sending a REGISTER_DISPOSITION action to the RAW callback endpoint. Provide the required reason code and optionally JSON metadata; the operation labels the disposition source as flow.
Inputs
- Callback URL / Environment (required) — Version 1 requires the callback URL, defaulted from
$json.meta.callbackUrl. Version 2 defaults to Automatic and readsmeta.callbackUrlfrom the input item; alternatively select Homologação, Produção, or URL Personalizada. Custom requires a callback URL. - Client ID (required) — Defaults from
$json.meta.clientId; identifies the RAW client. - Chat ID (required) — Defaults from
$json.meta.chatId; identifies the chat whose disposition is registered. - Bot ID — Defaults from
$json.meta.botId; when provided, the server uses that bot's configuration. - Next Step — If provided, updates the session step along with the action without navigating to it.
- Next Sub Step — If provided, updates the session subStep along with the action.
- Reason Code (required) — The
codeof a reason configured under Motivos de Encerramento, such asautoagendamento. - Metadata (JSON) — Optional extra data stored with the disposition. Defaults to
{}.
Output shape
One output item per input item, containing { ok: true, operation, response } after a successful callback request.
Posts a JSON body containing the client ID, chat ID, optional bot ID and step updates, and a
REGISTER_DISPOSITIONaction with the reason code,source: "flow", and non-empty metadata. With Continue On Fail enabled, failed items instead contain{ error }; otherwise an item failure raises an error.