mchuluq/laravel-whatsapp-notification-channel

laravel whatsapp notification channel for use in pair with my whatsapp micro service

dev-master 2025-05-13 12:18 UTC

This package is auto-updated.

Last update: 2025-05-13 12:24:56 UTC


README

A WhatsApp notification channel for Laravel 7.0 and above. I'm using it to pair with my whatsapp microservice

Installation

  1. Install the package via composer:
composer require mchuluq/laravel-whatsapp-notification-channel
  1. Publish the config file:
php artisan vendor:publish --tag=whatsapp-config
  1. Add these variables to your .env file:
WHATSAPP_BASE_URL=http://localhost:3000/api/
WHATSAPP_API_TOKEN=your-api-token-here
WHATSAPP_UNIT_ID=your-unit-id
WHATSAPP_DEBUG_MODE=false

Usage

use Illuminate\Notifications\Notification;

class OrderShipped extends Notification
{
    public function via($notifiable)
    {
        return ['whatsapp'];
    }

    public function toWhatsapp($notifiable)
    {
        return [
            'message' => 'Your order has been shipped!',
            'media_path' => 'path/to/media.jpg', // optional
            'document_path' => 'path/to/document.pdf' // optional
        ];
    }
}

Make sure your Notifiable model has the routeNotificationForWhatsapp method:

public function routeNotificationForWhatsapp()
{
    return $this->phone_number;
}