README

A robust and professional Laravel package for integrating with the Chatwoot API. Built with a clean architecture using Managers, Facades, and DTOs.

Features

• Multi-account Support: Seamlessly manage multiple Chatwoot connections/accounts.
• Type-safe DTOs: Use dedicated objects for Messages, Contacts, Agents, and Teams.
• WhatsApp/Meta Templates: Full support for Meta message templates via API.
• Labels & Custom Attributes: Extensive support for tagging and enriching data.
• Reporting API (v2): Access metrics and real-time statistics.
• Testing Helpers: Robust Chatwoot::fake() for reliable unit testing.

Documentation

Full documentation can be found in the docs directory:

• Configuration & Multi-account
• Basic Usage (DTOs & Facades)
• Media & Attachments
• WhatsApp Templates
• Labels & Custom Attributes
• Reporting API (v2)
• Testing & Mocking

Installation

composer require alan01777/laravel-chatwoot

Publish the config:

php artisan vendor:publish --tag="chatwoot-config"

Quick Start

use Chatwoot;

// Get all contacts
$contacts = Chatwoot::getContacts();

// Send a simple message
Chatwoot::sendMessage($conversationId, new MessageDTO(content: 'Hi!'));

// Use a specific account
Chatwoot::account('marketing')->getInboxes();

License

The MIT License (MIT). Please see License File for more information.