Typebot

App · 8 actions

Put your Typebot conversations to work: get each completed conversation with its answers named, list and look up results, delete them on request, and chat with a published bot from a workflow. Start a workflow on each new result.

Actions

ActionWhat it does
Delete resultsDelete some of a typebot's results for good, such as when someone asks for their data to be erased.
Get resultGet one conversation's answers, each named, with the bot's variables and whether it was completed.
Get typebotGet a typebot with its questions in order, the name each answer is saved under, its variables and its public link.
List resultsList a typebot's results, newest first, with each answer named: completed conversations, or all, since a day or matching some text.
List typebotsList the typebots in a workspace, or in all of them, newest first, with whether each is published.
List workspacesList the Typebot workspaces the connected account is in, with their plans.
Send replyAnswer the question a chat is waiting on, and get what the typebot says next.
Start chatStart a conversation with a published typebot, as a visitor to its page would, and get what it says first.

Delete results

Delete some of a typebot's results for good, such as when someone asks for their data to be erased.

Inputs

TypebottypebottextRequired
The typebot: pick it, or paste its ID or its link in Typebot's editor.
Result IDsresult_idstextRequired
The IDs of the results to delete, one per line, at most 50.

Outputs

deletedlist
The IDs of the results deleted
deleted_countnumber
How many were deleted
not_foundlist
IDs the typebot has no result for, or already deleted, so nothing was deleted
typebot_idtext
The typebot's ID
Example output
{
  "deleted": [
    "inf95965lmpmlwyjokbn2ka9"
  ],
  "deleted_count": 1,
  "not_found": [],
  "typebot_id": "cmw3y716y00041ktca0ng9hue"
}

Get result

Get one conversation's answers, each named, with the bot's variables and whether it was completed.

Inputs

TypebottypebottextRequired
The typebot: pick it, or paste its ID or its link in Typebot's editor.
Result IDresulttextRequired
The result's ID, from 'List results', 'Start chat' or the trigger.

Outputs

answer_listlist
Each answer with its question, in order
answersobject
The answers by name, such as answers['Email']: each named after the variable its question saves to, or else its group's title. The names are the bot author's, so read only the ones the request names
completedtrue/false
Whether the conversation reached the end of the flow
created_attext
When the conversation started (ISO 8601)
emailtext
The answer to the bot's first email question, whatever its name
idtext
The result's ID, for 'Get result' and 'Delete results'
phonetext
The answer to the bot's first phone question, if it has one
results_urltext
The typebot's results in Typebot
typebot_idtext
The typebot's ID
typebot_nametext
The typebot's name
variablesobject
The bot's variables with their values, by name, including ones set from the bot's link, such as variables['utm_source']
Example output
{
  "answer_list": [
    {
      "answer": "Grace Hopper",
      "field": "Name",
      "files": [],
      "group": "Welcome",
      "question": "Hi! What's your name?",
      "type": "text"
    },
    {
      "answer": "grace@example.com",
      "field": "Email",
      "files": [],
      "group": "Contact",
      "question": "Thanks {{Name}}! What's your email address?",
      "type": "email"
    },
    {
      "answer": "Support",
      "field": "Topic",
      "files": [],
      "group": "Topic",
      "question": "What can we help you with?",
      "type": "choice"
    },
    {
      "answer": "Our export to CSV fails since Tuesday.",
      "field": "Message",
      "files": [],
      "group": "Message",
      "question": "Anything else we should know?",
      "type": "text"
    }
  ],
  "answers": {
    "Email": "grace@example.com",
    "Message": "Our export to CSV fails since Tuesday.",
    "Name": "Grace Hopper",
    "Topic": "Support"
  },
  "completed": true,
  "created_at": "2026-11-05T19:38:42.027Z",
  "email": "grace@example.com",
  "id": "inf95965lmpmlwyjokbn2ka9",
  "phone": "",
  "results_url": "https://app.typebot.com/typebots/cmw3y716y00041ktca0ng9hue/results",
  "typebot_id": "cmw3y716y00041ktca0ng9hue",
  "typebot_name": "Lead form",
  "variables": {
    "Email": "grace@example.com",
    "Name": "Grace Hopper",
    "Topic": "Support",
    "utm_source": "newsletter"
  }
}

Get typebot

Get a typebot with its questions in order, the name each answer is saved under, its variables and its public link.

Inputs

TypebottypebottextRequired
The typebot: pick it, or paste its ID or its link in Typebot's editor.

Outputs

closedtrue/false
Whether it's closed to new conversations
created_attext
When it was made (ISO 8601)
edit_urltext
The typebot in Typebot's editor
idtext
The typebot's ID
nametext
The typebot's name
public_idtext
The name in its public link
public_urltext
Its public page, where people chat with it, once published
publishedtrue/false
Whether it's published, so people can chat with it
questionslist
Its questions, in the order of its flow
results_urltext
Its results in Typebot
updated_attext
When it was last changed
variableslist
The names of its variables
workspace_idtext
Its workspace's ID
Example output
{
  "closed": false,
  "created_at": "2026-11-05T19:37:58.473Z",
  "edit_url": "https://app.typebot.com/typebots/cmw3y716y00041ktca0ng9hue/edit",
  "id": "cmw3y716y00041ktca0ng9hue",
  "name": "Lead form",
  "public_id": "lead-form",
  "public_url": "https://typebot.co/lead-form",
  "published": true,
  "questions": [
    {
      "block_id": "b_name",
      "choices": [],
      "field": "Name",
      "group": "Welcome",
      "question": "Hi! What's your name?",
      "type": "text"
    },
    {
      "block_id": "b_email",
      "choices": [],
      "field": "Email",
      "group": "Contact",
      "question": "Thanks {{Name}}! What's your email address?",
      "type": "email"
    },
    {
      "block_id": "b_topic",
      "choices": [
        "Sales",
        "Support",
        "Partnership"
      ],
      "field": "Topic",
      "group": "Topic",
      "question": "What can we help you with?",
      "type": "choice"
    }
  ],
  "results_url": "https://app.typebot.com/typebots/cmw3y716y00041ktca0ng9hue/results",
  "updated_at": "2026-11-05T19:40:12.000Z",
  "variables": [
    "Name",
    "Email",
    "Topic",
    "utm_source"
  ],
  "workspace_id": "cmw3y2syb00001ktcido79kcb"
}

List results

List a typebot's results, newest first, with each answer named: completed conversations, or all, since a day or matching some text.

Inputs

TypebottypebottextRequired
The typebot: pick it, or paste its ID or its link in Typebot's editor.
Only completedcompleted_onlytrue/false
Only conversations that reached the end of the flow. Switch off to include people who left partway.Default: true.
Sincesincedate
Only conversations started on or after this day (UTC).
Searchsearchtext
Only results with this text in an answer or variable, such as an email address. Reads the newest 1000 results.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many were found
resultslist
The results, newest first, with their answers
typebot_nametext
The typebot's name
Example output
{
  "count": 1,
  "results": [
    {
      "answer_list": [
        {
          "answer": "Grace Hopper",
          "field": "Name",
          "files": [],
          "group": "Welcome",
          "question": "Hi! What's your name?",
          "type": "text"
        },
        {
          "answer": "grace@example.com",
          "field": "Email",
          "files": [],
          "group": "Contact",
          "question": "Thanks {{Name}}! What's your email address?",
          "type": "email"
        },
        {
          "answer": "Support",
          "field": "Topic",
          "files": [],
          "group": "Topic",
          "question": "What can we help you with?",
          "type": "choice"
        },
        {
          "answer": "Our export to CSV fails since Tuesday.",
          "field": "Message",
          "files": [],
          "group": "Message",
          "question": "Anything else we should know?",
          "type": "text"
        }
      ],
      "answers": {
        "Email": "grace@example.com",
        "Message": "Our export to CSV fails since Tuesday.",
        "Name": "Grace Hopper",
        "Topic": "Support"
      },
      "completed": true,
      "created_at": "2026-11-05T19:38:42.027Z",
      "email": "grace@example.com",
      "id": "inf95965lmpmlwyjokbn2ka9",
      "phone": "",
      "results_url": "https://app.typebot.com/typebots/cmw3y716y00041ktca0ng9hue/results",
      "typebot_id": "cmw3y716y00041ktca0ng9hue",
      "typebot_name": "Lead form",
      "variables": {
        "Email": "grace@example.com",
        "Name": "Grace Hopper",
        "Topic": "Support",
        "utm_source": "newsletter"
      }
    }
  ],
  "typebot_name": "Lead form"
}

List typebots

List the typebots in a workspace, or in all of them, newest first, with whether each is published.

Inputs

Workspaceworkspacetext
Only this workspace's typebots. Leave blank for every workspace.
Only publishedpublished_onlytrue/false
Leave out typebots that aren't published.Default: false.

Outputs

countnumber
How many there are
typebotslist
The typebots, newest first
Example output
{
  "count": 1,
  "typebots": [
    {
      "created_at": "2026-11-05T19:37:58.473Z",
      "edit_url": "https://app.typebot.com/typebots/cmw3y716y00041ktca0ng9hue/edit",
      "id": "cmw3y716y00041ktca0ng9hue",
      "name": "Lead form",
      "published": true,
      "workspace": "Acme",
      "workspace_id": "cmw3y2syb00001ktcido79kcb"
    }
  ]
}

List workspaces

List the Typebot workspaces the connected account is in, with their plans.

Inputs

None.

Outputs

countnumber
How many there are
workspaceslist
The workspaces the connected account is in
Example output
{
  "count": 1,
  "workspaces": [
    {
      "id": "cmw3y2syb00001ktcido79kcb",
      "name": "Acme",
      "plan": "starter"
    }
  ]
}

Send reply

Answer the question a chat is waiting on, and get what the typebot says next.

Inputs

Session IDsession_idtextRequired
The chat's session ID, from 'Start chat'.
ReplymessagetextRequired
The answer to send. For a choice, the choice's text.

Outputs

choiceslist
The choices it offers, when it asks for a choice
finishedtrue/false
Whether the conversation has ended
messageslist
What the bot said, in order
replytext
Everything the bot said, as one text
result_idtext
The result this conversation is saved as, from 'Start chat'
session_idtext
The chat's session ID, for 'Send reply'
waiting_fortext
What the bot asks for next: text, email, number, choice and the rest; empty once the conversation has ended
Example output
{
  "choices": [
    "Sales",
    "Support",
    "Partnership"
  ],
  "finished": false,
  "messages": [
    {
      "text": "What can we help you with?",
      "type": "text",
      "url": ""
    }
  ],
  "reply": "What can we help you with?",
  "result_id": "",
  "session_id": "j61kab2vuqeen0uw815gxnfu",
  "waiting_for": "choice"
}

Start chat

Start a conversation with a published typebot, as a visitor to its page would, and get what it says first.

Inputs

TypebottypebottextRequired
The typebot: pick it, or paste its ID or its link in Typebot's editor.
Variablesvariablesobject
Values for the bot's variables, by name, as its link would set them, such as utm_source.

Outputs

choiceslist
The choices it offers, when it asks for a choice
finishedtrue/false
Whether the conversation has ended
messageslist
What the bot said, in order
replytext
Everything the bot said, as one text
result_idtext
The result this conversation is saved as, from 'Start chat'
session_idtext
The chat's session ID, for 'Send reply'
waiting_fortext
What the bot asks for next: text, email, number, choice and the rest; empty once the conversation has ended
Example output
{
  "choices": [],
  "finished": false,
  "messages": [
    {
      "text": "Hi! What's your name?",
      "type": "text",
      "url": ""
    }
  ],
  "reply": "Hi! What's your name?",
  "result_id": "nzh9ej430bcd2mr4cdsbzhdu",
  "session_id": "j61kab2vuqeen0uw815gxnfu",
  "waiting_for": "text"
}

On this page