mkohei/laravel-td-notification-channel

Treasure Data Notification Channel for Laravel

v2.0.0 2023-04-20 06:33 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.0
• illuminate/notifications: ^10.0

Requires (Dev)

• mockery/mockery: ^1.3
• pestphp/pest: ^2.0
• phpunit/phpunit: ^10.0

MIT

• Kohei Matsumoto

README

Treasure Data notifications channel for Laravel

This package makes it easy to send Treasure Data using the Laravel notification system and the Treasure Data Postback API.

Contents

• Contents
• Installation
• Usage
• Testing
• License

Installation

composer require mkohei/laravel-td-notification-channel

Usage

Now you can use the channel in your via() method inside the notification:

use Mkohei\LaravelTdNotificationChannel\TreasureDataChannel;
use Mkohei\LaravelTdNotificationChannel\TreasureDataMessage;
use Illuminate\Notifications\Notification;

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

    public function toTreasureData($notifiable)
    {
        return TreasureDataMessage::create()
            ->data([
               'param1' => 'value',
               'param2' => 1234,
            ])
            ->apikey('YOUR_WRITE_ONLY_KEY')
            ->database('your_db')
            ->table('your_table');
    }
}

To store notifications in the appropriate regions, databases, and tables, define a routeNotificationForTreasureData method on your notifiable entity. This should return the Postback API endpoint for your region.

public function routeNotificationForTreasureData()
{
    return 'https://in.treasuredata.com';
}

Testing

composer test

License

MIT License.