# Typebot

> 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.

App · 8 actions. Web page: https://docs.lodol.com/docs/integrations/typebot

## Actions

### Delete results

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

**Inputs**

- Typebot (`typebot`, text, required): The typebot: pick it, or paste its ID or its link in Typebot's editor.
- Result IDs (`result_ids`, text, required): The IDs of the results to delete, one per line, at most 50.

**Outputs**

- `deleted` (list): The IDs of the results deleted
- `deleted_count` (number): How many were deleted
- `not_found` (list): IDs the typebot has no result for, or already deleted, so nothing was deleted
- `typebot_id` (text): The typebot's ID

**Example output**

```json
{
  "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**

- Typebot (`typebot`, text, required): The typebot: pick it, or paste its ID or its link in Typebot's editor.
- Result ID (`result`, text, required): The result's ID, from 'List results', 'Start chat' or the trigger.

**Outputs**

- `answer_list` (list): Each answer with its question, in order
- `answers` (object): 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
- `completed` (true/false): Whether the conversation reached the end of the flow
- `created_at` (text): When the conversation started (ISO 8601)
- `email` (text): The answer to the bot's first email question, whatever its name
- `id` (text): The result's ID, for 'Get result' and 'Delete results'
- `phone` (text): The answer to the bot's first phone question, if it has one
- `results_url` (text): The typebot's results in Typebot
- `typebot_id` (text): The typebot's ID
- `typebot_name` (text): The typebot's name
- `variables` (object): The bot's variables with their values, by name, including ones set from the bot's link, such as variables['utm_source']

**Example output**

```json
{
  "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**

- Typebot (`typebot`, text, required): The typebot: pick it, or paste its ID or its link in Typebot's editor.

**Outputs**

- `closed` (true/false): Whether it's closed to new conversations
- `created_at` (text): When it was made (ISO 8601)
- `edit_url` (text): The typebot in Typebot's editor
- `id` (text): The typebot's ID
- `name` (text): The typebot's name
- `public_id` (text): The name in its public link
- `public_url` (text): Its public page, where people chat with it, once published
- `published` (true/false): Whether it's published, so people can chat with it
- `questions` (list): Its questions, in the order of its flow
- `results_url` (text): Its results in Typebot
- `updated_at` (text): When it was last changed
- `variables` (list): The names of its variables
- `workspace_id` (text): Its workspace's ID

**Example output**

```json
{
  "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**

- Typebot (`typebot`, text, required): The typebot: pick it, or paste its ID or its link in Typebot's editor.
- Only completed (`completed_only`, true/false): Only conversations that reached the end of the flow. Switch off to include people who left partway. Default: `true`.
- Since (`since`, date): Only conversations started on or after this day (UTC).
- Search (`search`, text): Only results with this text in an answer or variable, such as an email address. Reads the newest 1000 results.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 500.

**Outputs**

- `count` (number): How many were found
- `results` (list): The results, newest first, with their answers
- `typebot_name` (text): The typebot's name

**Example output**

```json
{
  "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**

- Workspace (`workspace`, text): Only this workspace's typebots. Leave blank for every workspace.
- Only published (`published_only`, true/false): Leave out typebots that aren't published. Default: `false`.

**Outputs**

- `count` (number): How many there are
- `typebots` (list): The typebots, newest first

**Example output**

```json
{
  "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**

- `count` (number): How many there are
- `workspaces` (list): The workspaces the connected account is in

**Example output**

```json
{
  "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 ID (`session_id`, text, required): The chat's session ID, from 'Start chat'.
- Reply (`message`, text, required): The answer to send. For a choice, the choice's text.

**Outputs**

- `choices` (list): The choices it offers, when it asks for a choice
- `finished` (true/false): Whether the conversation has ended
- `messages` (list): What the bot said, in order
- `reply` (text): Everything the bot said, as one text
- `result_id` (text): The result this conversation is saved as, from 'Start chat'
- `session_id` (text): The chat's session ID, for 'Send reply'
- `waiting_for` (text): What the bot asks for next: text, email, number, choice and the rest; empty once the conversation has ended

**Example output**

```json
{
  "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**

- Typebot (`typebot`, text, required): The typebot: pick it, or paste its ID or its link in Typebot's editor.
- Variables (`variables`, object): Values for the bot's variables, by name, as its link would set them, such as utm_source.

**Outputs**

- `choices` (list): The choices it offers, when it asks for a choice
- `finished` (true/false): Whether the conversation has ended
- `messages` (list): What the bot said, in order
- `reply` (text): Everything the bot said, as one text
- `result_id` (text): The result this conversation is saved as, from 'Start chat'
- `session_id` (text): The chat's session ID, for 'Send reply'
- `waiting_for` (text): What the bot asks for next: text, email, number, choice and the rest; empty once the conversation has ended

**Example output**

```json
{
  "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"
}
```
