Chatwoot

Create conversations, send messages, and manage contacts in Chatwoot.

Customer supportAPI key2 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (2)
send_message
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("chatwoot", "send_message", {
    "conversationId": 1,
    "message": "<message>",
    "isPrivate": true
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Chatwoot answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "chatwoot-send-message",
  name: "Chatwoot: Send Message",
  description: "Calls Chatwoot when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("chatwoot", {
      "action": "send_message",
      "conversationId": 1,
      "message": "<message>",
      "isPrivate": true
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/chatwoot/send_message" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"conversationId":1,"message":"<message>","isPrivate":true}}'

Actions

send_messagein catalog

Send Message. Send a message reply to a Chatwoot conversation

Input	Type	Description
`conversationId`required	number	The numeric conversation display ID. Available from the trigger output.
`message`required	long text	The text message to send
`isPrivate`required	boolean	If checked, sends as a private note visible only to agents (not the contact)

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: chatwoot
Category: Customer support
Tags: live-chat, support, open-source, messaging
Package: @activepieces/piece-chatwoot@0.0.1
Tier: Community