# Chatwoot

> Run customer support in Chatwoot: reply to and resolve conversations, assign and label them, and manage contacts. Start a workflow when a conversation starts.

App · 14 actions. Web page: https://docs.lodol.com/docs/integrations/chatwoot

## Actions

### Assign conversation

Assign a conversation to an agent, or to a team.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.
- Agent (`agent`, text): The agent to assign it to, or me for the connected agent.
- Or team (`team`, text): Instead of an agent, the team to assign it to.

**Outputs**

- `assigned_id` (number): The agent's or team's number
- `assigned_to` (text): The agent's or team's name
- `conversation_id` (number): The conversation

**Example output**

```json
{
  "assigned_id": 5,
  "assigned_to": "Alex",
  "conversation_id": 1042
}
```

### Change contact

Change a contact's name, email, phone number, your ID for them or custom attributes.

**Inputs**

- Contact (`contact`, text, required): The contact's number, from 'Find contacts' or 'Create contact'.
- Name (`name`, text): A new name. Leave empty to keep it.
- Email (`email`, text): Their email address. Leave empty to keep it.
- Phone (`phone_number`, text): Their phone number in international form, such as +14155550100. Leave empty to keep it.
- Your ID for them (`identifier`, text): Their ID in your own system, such as a customer number. Leave empty to keep it.
- Custom attributes (`custom_attributes`, object): Extra details as fields and values, such as plan: Pro. Leave empty to keep it.

**Outputs**

- `created_at` (text): When they were added (ISO 8601)
- `custom_attributes` (object): Their custom attributes
- `email` (text): Their email address
- `id` (number): The contact's number
- `identifier` (text): Your ID for them
- `last_activity_at` (text): When they were last active (ISO 8601)
- `name` (text): Their name
- `phone_number` (text): Their phone number

**Example output**

```json
{
  "created_at": "2026-10-01T09:00:00Z",
  "custom_attributes": {
    "plan": "Pro"
  },
  "email": "sam@example.com",
  "id": 87,
  "identifier": "cus_123",
  "last_activity_at": "2026-10-28T09:05:00Z",
  "name": "Sam Lee",
  "phone_number": "+14155550100"
}
```

### Create contact

Add a contact, with an email, phone number or your own ID for them.

**Inputs**

- Name (`name`, text, required): Their name.
- Email (`email`, text): Their email address.
- Phone (`phone_number`, text): Their phone number in international form, such as +14155550100.
- Your ID for them (`identifier`, text): Their ID in your own system, such as a customer number.
- Custom attributes (`custom_attributes`, object): Extra details as fields and values, such as plan: Pro.
- Inbox (`inbox`, text): Also add them to this inbox, ready to start a conversation.

**Outputs**

- `created_at` (text): When they were added (ISO 8601)
- `custom_attributes` (object): Their custom attributes
- `email` (text): Their email address
- `id` (number): The contact's number
- `identifier` (text): Your ID for them
- `last_activity_at` (text): When they were last active (ISO 8601)
- `name` (text): Their name
- `phone_number` (text): Their phone number

**Example output**

```json
{
  "created_at": "2026-10-01T09:00:00Z",
  "custom_attributes": {
    "plan": "Pro"
  },
  "email": "sam@example.com",
  "id": 87,
  "identifier": "cus_123",
  "last_activity_at": "2026-10-28T09:05:00Z",
  "name": "Sam Lee",
  "phone_number": "+14155550100"
}
```

### Delete contact

Delete a contact and their conversations. It cannot be undone.

**Inputs**

- Contact (`contact`, text, required): The contact's number, from 'Find contacts' or 'Create contact'.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (number): The contact's number

**Example output**

```json
{
  "deleted": true,
  "id": 87
}
```

### Find contacts

Find contacts by name, email, phone number or your ID for them, most recently active first.

**Inputs**

- Search (`search`, text): A name, email, phone number or your ID. Leave empty for everyone.
- How many (`limit`, number): How many contacts. Defaults to 25. From 1 to 500.

**Outputs**

- `contacts` (list): The contacts
- `count` (number): How many contacts

**Example output**

```json
{
  "contacts": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "custom_attributes": {
        "plan": "Pro"
      },
      "email": "sam@example.com",
      "id": 87,
      "identifier": "cus_123",
      "last_activity_at": "2026-10-28T09:05:00Z",
      "name": "Sam Lee",
      "phone_number": "+14155550100"
    }
  ],
  "count": 1
}
```

### Get conversation

Get one conversation: who it's with, its status, labels, assignee and latest message.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.

**Outputs**

- `assignee_id` (number): The assigned agent's number; 0 if unassigned
- `assignee_name` (text): The assigned agent's name
- `contact_email` (text): The contact's email address
- `contact_id` (number): The contact's number
- `contact_name` (text): The contact's name
- `created_at` (text): When it started (ISO 8601)
- `id` (number): The conversation's number
- `inbox_id` (number): The inbox it came in through
- `labels` (list): Its labels
- `last_activity_at` (text): When it was last active (ISO 8601)
- `last_message` (text): The latest message
- `priority` (text): urgent, high, medium or low; empty if none
- `status` (text): open, pending, snoozed or resolved
- `team_name` (text): The assigned team's name
- `unread_count` (number): How many messages the agents haven't read

**Example output**

```json
{
  "assignee_id": 5,
  "assignee_name": "Alex",
  "contact_email": "sam@example.com",
  "contact_id": 87,
  "contact_name": "Sam Lee",
  "created_at": "2026-10-28T09:00:00Z",
  "id": 1042,
  "inbox_id": 3,
  "labels": [
    "billing"
  ],
  "last_activity_at": "2026-10-28T09:05:00Z",
  "last_message": "My invoice shows the wrong amount.",
  "priority": "high",
  "status": "open",
  "team_name": "Support",
  "unread_count": 1
}
```

### List conversations

List conversations, most recently active first, by status, assignee, inbox, label or words.

**Inputs**

- Status (`status`, text): Only conversations with this status. Defaults to open. One of: `all` (Any status), `open`, `pending`, `snoozed`, `resolved`. Default: `open`.
- Assigned (`assigned`, text): Only those assigned to you, to no one, or to someone. Defaults to all. One of: `all` (Anyone or no one), `me` (Assigned to me), `unassigned`, `assigned` (Assigned to someone). Default: `all`.
- Inbox (`inbox`, text): Only this inbox's conversations.
- Label (`label`, text): Only conversations with this label.
- Messages contain (`search`, text): Only conversations with a message containing these words.
- How many (`limit`, number): How many conversations. Defaults to 25. From 1 to 500.

**Outputs**

- `conversations` (list): The conversations, most recently active first
- `count` (number): How many conversations

**Example output**

```json
{
  "conversations": [
    {
      "assignee_id": 5,
      "assignee_name": "Alex",
      "contact_email": "sam@example.com",
      "contact_id": 87,
      "contact_name": "Sam Lee",
      "created_at": "2026-10-28T09:00:00Z",
      "id": 1042,
      "inbox_id": 3,
      "labels": [
        "billing"
      ],
      "last_activity_at": "2026-10-28T09:05:00Z",
      "last_message": "My invoice shows the wrong amount.",
      "priority": "high",
      "status": "open",
      "team_name": "Support",
      "unread_count": 1
    }
  ],
  "count": 1
}
```

### List inboxes

List the account's inboxes, or only those of one kind, such as API or email.

**Inputs**

- Kind (`channel`, text): Only inboxes of this kind. Leave empty for all. One of: `api`, `website` (Website chat), `email`, `whatsapp`, `sms`, `facebook`, `instagram`, `telegram`, `line`.

**Outputs**

- `count` (number): How many inboxes
- `inboxes` (list): The inboxes

**Example output**

```json
{
  "count": 1,
  "inboxes": [
    {
      "channel": "website",
      "id": 3,
      "name": "Website"
    }
  ]
}
```

### List messages

List a conversation's recent messages and notes, oldest first.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.

**Outputs**

- `conversation_id` (number): The conversation
- `count` (number): How many messages
- `messages` (list): The messages, oldest first

**Example output**

```json
{
  "conversation_id": 1042,
  "count": 1,
  "messages": [
    {
      "content": "Thanks, we're looking into it.",
      "created_at": "2026-10-28T09:06:00Z",
      "id": 9001,
      "kind": "outgoing",
      "private": false,
      "sender_name": "Alex",
      "sender_type": "user"
    }
  ]
}
```

### Send message

Reply in a conversation, or add a private note only agents see.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.
- Message (`content`, text, required): What to say.
- Private note (`private_note`, true/false): Add it as a note only agents see, rather than sending it to the contact. Off by default. Default: `false`.

**Outputs**

- `content` (text): What it says
- `conversation_id` (number): The conversation
- `created_at` (text): When it was sent (ISO 8601)
- `id` (number): The message's number
- `kind` (text): incoming, outgoing, activity or template
- `private` (true/false): True for a private note only agents see
- `sender_name` (text): Who sent it
- `sender_type` (text): contact, user (an agent) or agent_bot

**Example output**

```json
{
  "content": "Thanks, we're looking into it.",
  "conversation_id": 1042,
  "created_at": "2026-10-28T09:06:00Z",
  "id": 9001,
  "kind": "outgoing",
  "private": false,
  "sender_name": "Alex",
  "sender_type": "user"
}
```

### Set conversation labels

Set a conversation's labels, replacing the ones it has.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.
- Labels (`labels`, list): Its labels. Leave empty to take them all off.

**Outputs**

- `conversation_id` (number): The conversation
- `labels` (list): Its labels now

**Example output**

```json
{
  "conversation_id": 1042,
  "labels": [
    "billing",
    "vip"
  ]
}
```

### Set conversation priority

Set how urgent a conversation is.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.
- Priority (`priority`, text, required): How urgent it is. One of: `urgent`, `high`, `medium`, `low`, `none` (No priority).

**Outputs**

- `conversation_id` (number): The conversation
- `priority` (text): Its priority; empty for none

**Example output**

```json
{
  "conversation_id": 1042,
  "priority": "urgent"
}
```

### Set conversation status

Open, resolve, mark pending or snooze a conversation.

**Inputs**

- Conversation (`conversation`, text, required): The conversation's number, as shown in Chatwoot (#123), or its link.
- Status (`status`, text, required): The conversation's new status. One of: `open`, `pending`, `snoozed`, `resolved`.
- Snooze until (`snooze_until`, date and time): When snoozing, when to reopen it. Leave empty to reopen at the contact's next reply.

**Outputs**

- `conversation_id` (number): The conversation
- `status` (text): Its new status

**Example output**

```json
{
  "conversation_id": 1042,
  "status": "resolved"
}
```

### Start conversation

Start a conversation with a contact in an inbox, with a first message.

**Inputs**

- Inbox (`inbox`, text, required): The inbox to start it in: an API, website, email or SMS inbox.
- Contact (`contact`, text, required): The contact's number, from 'Find contacts' or 'Create contact'.
- First message (`message`, text, required): What to say first.
- Status (`status`, text): Open, pending or resolved. Defaults to open. One of: `open`, `pending`, `resolved`.

**Outputs**

- `assignee_id` (number): The assigned agent's number; 0 if unassigned
- `assignee_name` (text): The assigned agent's name
- `contact_email` (text): The contact's email address
- `contact_id` (number): The contact's number
- `contact_name` (text): The contact's name
- `created_at` (text): When it started (ISO 8601)
- `id` (number): The conversation's number
- `inbox_id` (number): The inbox it came in through
- `labels` (list): Its labels
- `last_activity_at` (text): When it was last active (ISO 8601)
- `last_message` (text): The latest message
- `priority` (text): urgent, high, medium or low; empty if none
- `status` (text): open, pending, snoozed or resolved
- `team_name` (text): The assigned team's name
- `unread_count` (number): How many messages the agents haven't read

**Example output**

```json
{
  "assignee_id": 0,
  "assignee_name": "",
  "contact_email": "sam@example.com",
  "contact_id": 87,
  "contact_name": "Sam Lee",
  "created_at": "2026-10-28T09:00:00Z",
  "id": 1042,
  "inbox_id": 3,
  "labels": [],
  "last_activity_at": "2026-10-28T09:05:00Z",
  "last_message": "My invoice shows the wrong amount.",
  "priority": "",
  "status": "open",
  "team_name": "Support",
  "unread_count": 1
}
```
