@gibahjoe/chatwoot-mcp-server
MCP server for Chatwoot API integration - manage conversations, contacts, and messages
Versions
1.3.0latest1.2.01.1.01.0.0Tools 16
chatwoot_list_conversations List conversations from a Chatwoot account with filtering options. This tool retrieves conversations from Chatwoot, allowing you to filter by status, assignee, and inbox. Supports pagination for large result sets. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - page (number): Page number for pagination, starts at 1 (default: 1) - status (string): Filter by conversation status - "open", "resolved", "pending", "snoozed", or "all" (default: "open") - assignee_type (string): Filter by assignee - "me", "unassigned", or "all" (optional) - inbox_id (number): Filter by specific inbox ID (optional) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: A list of conversations with details including: - Conversation ID, status, and inbox - Contact information (name, email) - Assignee details - Message count and unread count - Last activity timestamp Examples: - List all open conversations: { account_id: 1, status: "open" } - List unassigned conversations: { account_id: 1, assignee_type: "unassigned" } - List conversations in specific inbox: { account_id: 1, inbox_id: 5 }
chatwoot_get_conversation Get detailed information about a specific Chatwoot conversation. This tool retrieves full details for a single conversation including contact info, assignee, labels, and custom attributes. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - conversation_id (number): The ID of the conversation to retrieve (required) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: Full conversation details including: - Status, inbox, and metadata - Complete contact information - Assignee details - Labels and custom attributes - Message statistics Examples: - Get conversation details: { account_id: 1, conversation_id: 123 }
chatwoot_list_messages List all messages in a Chatwoot conversation. This tool retrieves all messages from a specific conversation, including message content, sender information, timestamps, and attachments. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - conversation_id (number): The ID of the conversation (required) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: List of messages with: - Message ID and content - Message type (incoming/outgoing) - Sender information (name, type) - Timestamp - Attachment information - Private flag (for internal notes) Examples: - List all messages: { account_id: 1, conversation_id: 123 }
chatwoot_create_message Create a new message in a Chatwoot conversation. This tool sends a message in an existing conversation. Can be used for outgoing messages to customers or private internal notes. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - conversation_id (number): The ID of the conversation (required) - content (string): The message content (required) - message_type (string): Type of message - "outgoing" or "incoming" (default: "outgoing") - private (boolean): Whether this is a private internal note (default: false) Returns: Created message details including ID and confirmation Examples: - Send a reply: { account_id: 1, conversation_id: 123, content: "Thank you for contacting us!" } - Add internal note: { account_id: 1, conversation_id: 123, content: "Customer called for follow-up", private: true }
chatwoot_upload_file Upload a local file to a Chatwoot account. Use this before creating or updating a help center article that needs an image or file. The tool returns file_url and blob_id. To embed an uploaded image in article content, add Markdown like  using the returned file_url. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - file_path (string): Local path to the file to upload (required) - filename (string): Optional filename to send to Chatwoot - content_type (string): Optional MIME type, such as image/png - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: Upload details including: - file_url: URL to use in article Markdown or other Chatwoot content - blob_id: Chatwoot/Active Storage blob identifier
chatwoot_list_help_center_portals List help center portals for a Chatwoot account. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: A list of help center portals with locale configuration, linked inbox, article counts, category counts, and domain metadata.
chatwoot_create_help_center_portal Create a help center portal in a Chatwoot account. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - name (string): Help center name (required) - slug (string): URL slug for the help center (required) - color (string): Header color in hex format (optional) - custom_domain (string): Custom help center domain (optional) - header_text (string): Help center header text (optional) - homepage_link (string): Main website or dashboard URL (optional) - page_title (string): Browser page title (optional) - archived (boolean): Whether the portal is archived (optional) - config (object): Locale config with allowed_locales and default_locale (optional)
chatwoot_update_help_center_portal Update a help center portal in a Chatwoot account. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - name, slug, color, custom_domain, header_text, homepage_link, page_title, archived, config: Portal fields to update
chatwoot_list_help_center_categories List categories in a Chatwoot help center portal. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - locale (string): Locale filter, such as "en" (optional) - page (number): Page number for pagination, starts at 1 (default: 1) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: A list of help center categories with article counts and pagination metadata.
chatwoot_create_help_center_category Create a category in a Chatwoot help center portal. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - name (string): Category name (required) - description (string): Category description (optional) - slug (string): Category URL slug (optional) - locale (string): Category locale (optional) - icon (string): Category icon as a string (optional) - position (number): Sort position (optional) - parent_category_id (number): Parent category ID (optional) - associated_category_id (number): Associated category ID for related locales/categories (optional)
chatwoot_update_help_center_category Update a category in a Chatwoot help center portal. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - category_id (number): Category ID to update (required) - name (string): Category name (optional) - description (string): Category description (optional) - slug (string): Category URL slug (optional) - locale (string): Category locale (optional) - icon (string): Category icon as a string (optional) - position (number): Sort position (optional) - parent_category_id (number): Parent category ID (optional) - associated_category_id (number): Associated category ID for related locales/categories (optional)
chatwoot_delete_help_center_category Delete a category from a Chatwoot help center portal. Chatwoot does not expose category archiving. Deleting a category removes the category; existing articles are left uncategorized by Chatwoot. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - category_id (number): Category ID to delete (required)
chatwoot_list_help_center_articles List articles in a Chatwoot help center portal. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - locale (string): Locale filter, such as "en" (optional) - category_slug (string): Category slug filter, such as "downloads-and-offline" (optional) - query (string): Full-text search across article title, description, and content (optional) - status (string): Filter by "draft", "published", or "archived" (optional) - author_id (number): Filter by author user ID (optional) - page (number): Page number for pagination, starts at 1 (default: 1) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: A list of help center articles with status, category, author, view counts, and pagination metadata.
chatwoot_get_help_center_article Get one full article from a Chatwoot help center portal without listing pages. Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - article_id (number): Article ID to fetch (required) - response_format (string): Output format - "markdown" or "json" (default: "markdown") Returns: Full article details including title, description, status, category, views, metadata, and content.
chatwoot_create_help_center_article Create an article in a Chatwoot help center portal. For images or file embeds, first call chatwoot_upload_file, then insert the returned file_url into content using Markdown such as . Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - title (string): Article title (required) - content (string): Article body content (required) - slug (string): Article URL slug (optional) - description (string): Article description (optional) - category_id (number): Category ID (optional) - author_id (number): Author agent ID (optional) - status (string): "draft", "published", or "archived"; tool sends Chatwoot's numeric enum value (default: "draft") - locale (string): Article locale (optional) - position (number): Sort position (optional) - associated_article_id (number): Associated article ID for related locales/articles (optional) - meta (object): Search metadata such as tags, title, or description (optional)
chatwoot_update_help_center_article Update an article in a Chatwoot help center portal. For images or file embeds, first call chatwoot_upload_file, then insert the returned file_url into content using Markdown such as . Args: - account_id (number): The numeric ID of the Chatwoot account (required) - portal_id (string): Help center portal slug; Chatwoot names this path parameter "id" (required) - article_id (number): Article ID to update (required) - title (string): Article title (optional) - content (string): Article body content (optional) - slug (string): Article URL slug (optional) - description (string): Article description (optional) - category_id (number): Category ID (optional) - author_id (number): Author agent ID (optional) - status (string): "draft", "published", or "archived"; tool sends Chatwoot's numeric enum value (optional) - locale (string): Article locale (optional) - position (number): Sort position (optional) - associated_article_id (number): Associated article ID for related locales/articles (optional) - meta (object): Search metadata such as tags, title, or description (optional)
Permissions 2
network medium env_vars low