Aysali API icon

Aysali API

Interact with Aysali API

Integration → Typebot

AI-generated

Summary

Execute Typebot integration actions via the Aysali API node.

Inputs

  • instanceName (required) — Identifier for the WhatsApp instance that will send the message.
  • url (required) — Base URL of the Typebot instance.
  • typebot (required) — Name of the Typebot flow (used for create, update, start).
  • resourceForTypebot — Action to perform. Options: createTypebot, findTypebot, updateTypebot, deleteTypebot, startTypebot, fetchSessionsTypebot, changeStatusTypebot. Default: createTypebot.
  • typebotId — ID of the Typebot to fetch, update, delete, list sessions, or change session status. Leave empty to list all when fetching.
  • triggerType — Whether to trigger on a specific keyword or any message. Options: keyword, all. Default: keyword.
  • triggerOperator — How the trigger value is matched. Options: contains, equals, startsWith, endsWith, regex. Default: contains.
  • triggerValue — Word, phrase, or regex used as the trigger to start Typebot.
  • expire — Minutes without replies before the bot is disabled. Default: 0.
  • delayMessage — Bot message delay in milliseconds. Default: 1000.
  • keywordFinish — Word or phrase used to close the bot. Default: #sair.
  • unknownMessage — Message sent when user input is not recognized. Default: Unrecognized message.
  • listeningFromMe — Whether the bot listens to messages sent by the instance owner. Default: false.
  • stopBotFromMe — Whether to pause the bot when the instance sends a message. Default: false.
  • keepOpen — Whether to keep the bot session open after finishing. Default: false.
  • debounceTime — Seconds to wait for further messages before merging them. Default: 0.
  • remoteJid — Recipient remote JID (WhatsApp number) to start the Typebot with.
  • startSession — Whether to enable or disable integration with Chatwoot (as per property). Default: false.
  • variables — Collection of variable name/value pairs to send to Typebot when starting a session.
  • status — Session status to set. Options: opened, paused, closed. Default: opened.

Output shape

Varies by action: returns the created Typebot object, a list of Typebots, the updated Typebot, deletion confirmation, a list of sessions, or a status update.

All results are returned as JSON from the Typebot API via the evolutionRequest helper.

Examples

Example 1: Create a new Typebot

Set resourceForTypebot=createTypebot, provide instanceName, url, typebot name, trigger settings, expiration, delays, finish/unknown messages, listening/stopping options, debounce time.

Example 2: Start a Typebot session for a user

Set resourceForTypebot=startTypebot, provide instanceName, remoteJid (WhatsApp number), optional variables, and optionally startSession flag.

Example 3: List all Typebots

Set resourceForTypebot=findTypebot and leave typebotId empty.

Links

Discussion