Weave Code
Laravel Chatwork Laravel Package
sun-asterisk/laravel-chatwork
Laravel Chatwork integration by Sun Asterisk for sending messages through the Chatwork API. Includes a notification channel, facade, and simple configuration so Laravel apps can deliver alerts and updates to Chatwork rooms.
A package for Laravel Framework to manipulate with Chatwork API easily
Frequently asked questions about Laravel Chatwork
- How do I install sun-asterisk/laravel-chatwork in a Laravel application?
- Install it with Composer using composer require sun-asterisk/laravel-chatwork. The package ships a service provider that is auto-discovered, plus a publishable config file you publish with php artisan vendor:publish. Then set CHATWORK_API_TOKEN in your .env file and you can resolve the facade or inject the client. The whole setup is designed to take well under a day for a single Laravel developer.
- Which Laravel and PHP versions does this Chatwork package support?
- The package declares its supported Laravel and PHP ranges in composer.json through the illuminate/support constraint. Because it comes from a small research-org namespace, that constraint often lags the newest framework majors, so check it against your installed Laravel and PHP versions before committing. Verify auto-discovery works on your version, or register the service provider manually if needed.
- How do I configure the Chatwork API token for Laravel?
- Publish the package config file to config/chatwork.php and put your token in the CHATWORK_API_TOKEN environment variable. The service provider resolves that config into a container singleton, so the facade and injected client pick it up automatically. Keep the token out of version control and set it per environment, since authentication is API-token only.
- How do I send a message to a Chatwork room using the facade?
- Resolve the Chatwork facade and call the message endpoint with the target room ID and body, which is the package's core use case. The wrapper exposes room, message, member, file, and task endpoints so you avoid hand-rolling Guzzle clients. Wrap the call in a queued job or a small service class rather than calling the facade directly from controllers.
- Can I use this package as a Laravel notification channel?
- Yes, it includes a notification channel alongside the facade and config, so Chatwork can be a delivery target for Laravel's built-in notification system. That makes it a good fit for ops alerts, CI/CD build results, and workflow updates pushed into a room. It is a one-way delivery mechanism, not a full chat platform integration.
- Does laravel-chatwork support webhooks or incoming Chatwork events?
- No, it is strictly a request/response SDK wrapper around the Chatwork REST API with no documented inbound webhook support. That means it suits outbound notifications and task creation, not bidirectional chat features. If you need event-driven behaviour, Chatwork's own API and webhook surface is limited compared with Slack or Teams, so plan accordingly.
- How does the package handle Chatwork API errors and rate limits?
- Wrappers of this size typically return raw decoded arrays and let 4xx and 429 responses bubble up as generic exceptions, so confirm the behaviour before you rely on it. Check specifically whether 429 and Retry-After headers are surfaced to the caller, because Chatwork enforces rate limits. If they are not, add your own retry and backoff logic in the layer that calls the SDK.
- Is sun-asterisk/laravel-chatwork safe to use in production?
- It is workable for low-risk outbound notifications, but the maintenance signals are weak: modest star count, no dependents, and a research-org namespace that suggests an open-sourced internal utility. Assume a bus factor of one, no guarantee of a release cadence, and unverified test coverage. Mitigate by hiding it behind your own interface and pinning the version in composer.lock.
- How should I structure my Laravel code so I can swap this Chatwork package later?
- Do not call the facade directly from controllers, jobs, and models. Define a one-method-deep contract such as App\Contracts\ChatNotifier with a ChatworkNotifier implementation and bind it in a service provider. That costs roughly half a day and turns vendor abandonment from a rewrite into swapping a single binding, and it also gives you a clean place to add retries and error handling.
- What alternatives exist for integrating Chatwork into Laravel, and is this package a good choice?
- The realistic alternative is a thin custom Guzzle client around the Chatwork REST API, which you control fully but must maintain yourself. This package is a reasonable consolidation vehicle if Chatwork is already your organisation's chat tool and you are on a supported Laravel 8 to 10 style stack on PHP 8.x. It is a poor fit for multi-tenant SaaS or per-user OAuth scenarios, since authentication here is API-token only.
Weaver
How can I help you explore Laravel packages today?