janyksteenbeek/laravel-bird-notifications

Bird notification channel for Laravel

v1.1 2025-01-02 10:14 UTC

Requires

• php: ^8.2
• ext-json: *
• guzzlehttp/guzzle: ^7.2
• illuminate/notifications: ^9.0|^10.0|^11.0
• illuminate/queue: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0

MIT

• Janyk Steenbeek

README

This package provides a Laravel notification channel for sending SMS messages using the Bird API.

Installation

You can install this package via Composer:

composer require janyksteenbeek/laravel-bird-notifications

Configuration

1. Add your Bird credentials to your .env file:

BIRD_ACCESS_KEY=your_access_key
BIRD_WORKSPACE_ID=your_workspace_id
BIRD_CHANNEL_ID=your_channel_id

1. Add the configuration to config/services.php:

'bird' => [
    'access_key' => env('BIRD_ACCESS_KEY'),
    'workspace' => env('BIRD_WORKSPACE_ID'),
    'channel' => env('BIRD_CHANNEL_ID'),
],

Usage

Basic Usage

First, create a notification class using Laravel's notification command:

php artisan make:notification OrderConfirmation

Then, implement the toBird method in your notification class:

use NotificationChannels\Bird\BirdMessage;
use NotificationChannels\Bird\BirdChannel;

class OrderConfirmation extends Notification
{
    public function via($notifiable)
    {
        return [BirdChannel::class];
    }

    public function toBird($notifiable)
    {
        return (new BirdMessage())
            ->setBody("Your order #{$this->order->id} has been confirmed!")
            ->setRecipients($notifiable->phone_number);
    }
}

Using BirdRoute for Dynamic Configuration

BirdRoute allows you to customize the Bird configuration per notification. This is useful when you need to:

• Send to multiple recipients
• Use different access tokens
• Use different workspaces
• Use different channels

Method 1: Using BirdRoute in the Notifiable Model

use NotificationChannels\Bird\BirdRoute;

class User extends Authenticatable
{
    public function routeNotificationForBird($notification)
    {
        return BirdRoute::make(
            recipients: [$this->phone_number],
            token: 'custom-access-token',        // optional
            workspace: 'custom-workspace-id',     // optional
            channel: 'custom-channel-id'         // optional
        );
    }
}

Method 2: Using BirdRoute in the Notification

use NotificationChannels\Bird\BirdMessage;
use NotificationChannels\Bird\BirdRoute;

class OrderConfirmation extends Notification
{
    public function toBird($notifiable)
    {
        // Create a BirdRoute instance
        $route = BirdRoute::make(
            recipients: ['[phone]', '[phone]'],
            workspace: 'special-workspace-id',
            channel: 'urgent-channel-id'
        );

        // Create your message
        $message = (new BirdMessage())
            ->setBody("Your order #{$this->order->id} has been confirmed!");

        // Apply the route configuration
        if ($route->token) {
            $message->setAccessToken($route->token);
        }
        $message->setRecipients($route->recipients);

        return $message;
    }
}

Sending to Multiple Recipients

public function toBird($notifiable)
{
    return (new BirdMessage())
        ->setBody('Your order has been confirmed!')
        ->setRecipients([
            '[phone]',
            '[phone]'
        ]);
}

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

Credits

• All Contributors

Special thanks to https://github.com/laravel-notification-channels/messagebird for providing a good base.

License

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