Chatwoot
App · 14 actions
Run customer support in Chatwoot: reply to and resolve conversations, assign and label them, and manage contacts. Start a workflow when a conversation starts.
Actions
| Action | What it does |
|---|---|
| Assign conversation | Assign a conversation to an agent, or to a team. |
| Change contact | Change a contact's name, email, phone number, your ID for them or custom attributes. |
| Create contact | Add a contact, with an email, phone number or your own ID for them. |
| Delete contact | Delete a contact and their conversations. |
| Find contacts | Find contacts by name, email, phone number or your ID for them, most recently active first. |
| Get conversation | Get one conversation: who it's with, its status, labels, assignee and latest message. |
| List conversations | List conversations, most recently active first, by status, assignee, inbox, label or words. |
| List inboxes | List the account's inboxes, or only those of one kind, such as API or email. |
| List messages | List a conversation's recent messages and notes, oldest first. |
| Send message | Reply in a conversation, or add a private note only agents see. |
| Set conversation labels | Set a conversation's labels, replacing the ones it has. |
| Set conversation priority | Set how urgent a conversation is. |
| Set conversation status | Open, resolve, mark pending or snooze a conversation. |
| Start conversation | Start a conversation with a contact in an inbox, with a first message. |
Assign conversation
Assign a conversation to an agent, or to a team.
Inputs
- Conversation
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
- Agent
agenttext - The agent to assign it to, or me for the connected agent.
- Or team
teamtext - Instead of an agent, the team to assign it to.
Outputs
assigned_idnumber- The agent's or team's number
assigned_totext- The agent's or team's name
conversation_idnumber- The conversation
Example output
{
"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
contacttextRequired - The contact's number, from 'Find contacts' or 'Create contact'.
- Name
nametext - A new name. Leave empty to keep it.
- Email
emailtext - Their email address. Leave empty to keep it.
- Phone
phone_numbertext - Their phone number in international form, such as +14155550100. Leave empty to keep it.
- Your ID for them
identifiertext - Their ID in your own system, such as a customer number. Leave empty to keep it.
- Custom attributes
custom_attributesobject - Extra details as fields and values, such as plan: Pro. Leave empty to keep it.
Outputs
created_attext- When they were added (ISO 8601)
custom_attributesobject- Their custom attributes
emailtext- Their email address
idnumber- The contact's number
identifiertext- Your ID for them
last_activity_attext- When they were last active (ISO 8601)
nametext- Their name
phone_numbertext- Their phone number
Example output
{
"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
nametextRequired - Their name.
- Email
emailtext - Their email address.
- Phone
phone_numbertext - Their phone number in international form, such as +14155550100.
- Your ID for them
identifiertext - Their ID in your own system, such as a customer number.
- Custom attributes
custom_attributesobject - Extra details as fields and values, such as plan: Pro.
- Inbox
inboxtext - Also add them to this inbox, ready to start a conversation.
Outputs
created_attext- When they were added (ISO 8601)
custom_attributesobject- Their custom attributes
emailtext- Their email address
idnumber- The contact's number
identifiertext- Your ID for them
last_activity_attext- When they were last active (ISO 8601)
nametext- Their name
phone_numbertext- Their phone number
Example output
{
"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
contacttextRequired - The contact's number, from 'Find contacts' or 'Create contact'.
Outputs
deletedtrue/false- True once deleted
idnumber- The contact's number
Example output
{
"deleted": true,
"id": 87
}Find contacts
Find contacts by name, email, phone number or your ID for them, most recently active first.
Inputs
- Search
searchtext - A name, email, phone number or your ID. Leave empty for everyone.
- How many
limitnumber - How many contacts. Defaults to 25.From 1 to 500.
Outputs
contactslist- The contacts
countnumber- How many contacts
Example output
{
"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
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
Outputs
assignee_idnumber- The assigned agent's number; 0 if unassigned
assignee_nametext- The assigned agent's name
contact_emailtext- The contact's email address
contact_idnumber- The contact's number
contact_nametext- The contact's name
created_attext- When it started (ISO 8601)
idnumber- The conversation's number
inbox_idnumber- The inbox it came in through
labelslist- Its labels
last_activity_attext- When it was last active (ISO 8601)
last_messagetext- The latest message
prioritytext- urgent, high, medium or low; empty if none
statustext- open, pending, snoozed or resolved
team_nametext- The assigned team's name
unread_countnumber- How many messages the agents haven't read
Example output
{
"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
statustext - Only conversations with this status. Defaults to open.One of:
all(Any status),open,pending,snoozed,resolved. Default:open. - Assigned
assignedtext - 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
inboxtext - Only this inbox's conversations.
- Label
labeltext - Only conversations with this label.
- Messages contain
searchtext - Only conversations with a message containing these words.
- How many
limitnumber - How many conversations. Defaults to 25.From 1 to 500.
Outputs
conversationslist- The conversations, most recently active first
countnumber- How many conversations
Example output
{
"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
channeltext - Only inboxes of this kind. Leave empty for all.One of:
api,website(Website chat),email,whatsapp,sms,facebook,instagram,telegram,line.
Outputs
countnumber- How many inboxes
inboxeslist- The inboxes
Example output
{
"count": 1,
"inboxes": [
{
"channel": "website",
"id": 3,
"name": "Website"
}
]
}List messages
List a conversation's recent messages and notes, oldest first.
Inputs
- Conversation
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
Outputs
conversation_idnumber- The conversation
countnumber- How many messages
messageslist- The messages, oldest first
Example output
{
"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
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
- Message
contenttextRequired - What to say.
- Private note
private_notetrue/false - Add it as a note only agents see, rather than sending it to the contact. Off by default.Default:
false.
Outputs
contenttext- What it says
conversation_idnumber- The conversation
created_attext- When it was sent (ISO 8601)
idnumber- The message's number
kindtext- incoming, outgoing, activity or template
privatetrue/false- True for a private note only agents see
sender_nametext- Who sent it
sender_typetext- contact, user (an agent) or agent_bot
Example output
{
"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
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
- Labels
labelslist - Its labels. Leave empty to take them all off.
Outputs
conversation_idnumber- The conversation
labelslist- Its labels now
Example output
{
"conversation_id": 1042,
"labels": [
"billing",
"vip"
]
}Set conversation priority
Set how urgent a conversation is.
Inputs
- Conversation
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
- Priority
prioritytextRequired - How urgent it is.One of:
urgent,high,medium,low,none(No priority).
Outputs
conversation_idnumber- The conversation
prioritytext- Its priority; empty for none
Example output
{
"conversation_id": 1042,
"priority": "urgent"
}Set conversation status
Open, resolve, mark pending or snooze a conversation.
Inputs
- Conversation
conversationtextRequired - The conversation's number, as shown in Chatwoot (#123), or its link.
- Status
statustextRequired - The conversation's new status.One of:
open,pending,snoozed,resolved. - Snooze until
snooze_untildate and time - When snoozing, when to reopen it. Leave empty to reopen at the contact's next reply.
Outputs
conversation_idnumber- The conversation
statustext- Its new status
Example output
{
"conversation_id": 1042,
"status": "resolved"
}Start conversation
Start a conversation with a contact in an inbox, with a first message.
Inputs
- Inbox
inboxtextRequired - The inbox to start it in: an API, website, email or SMS inbox.
- Contact
contacttextRequired - The contact's number, from 'Find contacts' or 'Create contact'.
- First message
messagetextRequired - What to say first.
- Status
statustext - Open, pending or resolved. Defaults to open.One of:
open,pending,resolved.
Outputs
assignee_idnumber- The assigned agent's number; 0 if unassigned
assignee_nametext- The assigned agent's name
contact_emailtext- The contact's email address
contact_idnumber- The contact's number
contact_nametext- The contact's name
created_attext- When it started (ISO 8601)
idnumber- The conversation's number
inbox_idnumber- The inbox it came in through
labelslist- Its labels
last_activity_attext- When it was last active (ISO 8601)
last_messagetext- The latest message
prioritytext- urgent, high, medium or low; empty if none
statustext- open, pending, snoozed or resolved
team_nametext- The assigned team's name
unread_countnumber- How many messages the agents haven't read
Example output
{
"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
}