README

This package enhances laravel slack notifications, allowing to send direct messages.

Compatibility

Installation

Require package

composer require deegitalbe/laravel-trustup-io-slack-notifications

Env variables

SLACK_API_TOKEN=

Usage

Configure your models

use Illuminate\Database\Eloquent\Model;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Traits\Slack\SlackNotifiable;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Contracts\Slack\SlackNotifiableContract;

use Illuminate\Notifications\Notification;

class User extends Model implements SlackNotifiableContract
{
    use SlackNotifiable;
}

Configure your notification

Extending slack notification

use Illuminate\Notifications\Messages\SlackMessage;
use Deegitalbe\LaravelTrustupIoSlackNotifications\SlackNotification;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Enum\SlackChannel;

class OrderReceived extends SlackNotification
{
    public function slackChannel($notifiable): string|SlackChannel
    {
        return SlackChannel::PRODUCTS;
    }

    public function slackMessage(SlackMessage $message, $notifiable): SlackMessage
    {
        return $message->content("A new order has been made.");
    }
}

Implementing contract and using trait

use Illuminate\Notifications\Messages\SlackMessage;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Enum\SlackChannel;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Traits\Slack\IsSlackNotification;
use Deegitalbe\LaravelTrustupIoSlackNotifications\Contracts\Slack\SlackNotificationContract;

class OrderReceived extends Notification implements SlackNotificationContract
{
    use IsSlackNotification;

    public function slackChannel($notifiable): string|SlackChannel
    {
        return $notifiable->getSlackId();
    }

    public function slackMessage(SlackMessage $message, $notifiable): SlackMessage
    {
        return $message->content("A new order has been made.");
    }
}

Send notification to slack channel

// Create notification
<?php

namespace Deegitalbe\LaravelTrustupIoSlackNotifications\Tests\Utils\Notifications;

use Deegitalbe\LaravelTrustupIoSlackNotifications\SlackChannelNotification;
use Illuminate\Notifications\Messages\SlackMessage;

class TestingNotification extends SlackChannelNotification
{
    public function slackMessage(SlackMessage $message, $notifiable): SlackMessage
    {
        return $message->attachment(function ($attachment) {
            $attachment->color('#36a64f')
                ->author('🚨 New Activation Request')
                ->title("Tenant #test")
                ->fields([
                    'Enterprise' => "test",
                    'Account Type' => "test",
                    'Admin First Name' => "test",
                    'Admin Last Name' => "test",
                    'VAT Number' => "test",
                    'Created At' => "test",
                ])
                ->footer('TrustUp')
                ->footerIcon("test")
                ->timestamp(now());
        });
    }
}

// Send notification
SlackChannel::TECH_DEV->notify($notification);