pascallieverse / laravel-bitrix24-notification

1.6 2024-11-13 15:23 UTC

Requires

• php: ^8.0.1
• illuminate/notifications: *
• illuminate/queue: *
• illuminate/support: *

Requires (Dev)

• mockery/mockery: ^1.5
• phpunit/phpunit: ^10

MIT

• Pascal Lieverse

• notification
• laravel
• Bitrix24

Published on Packagist.org on 2024-11-13 15:25 UTC

README

This package makes it easy to send notifications using the Bitrix Bot Platform with Laravel.

Installation

You can install the package via composer:

composer require "pascallieverse/laravel-bitrix24-notification"

And finally publish the config file:

php artisan vendor:publish --provider="PascalLieverse\Bitrix24\Bitrix24ServiceProvider"

Setting up your Bitrix24 bot

1. Inside bitrix24 navigate to: Extensions -> Applications -> Developer resources -> Add a chat bot -> Notify employees in the chat.
2. Fill in the required fields to create the bot. The bot type should be "Chat bot, immediate response".
3. Copy the "Webhook to call REST API" url and place this value inside your env file as BITRIX_WEBHOOK_URL.
4. Copy the "Bot CLIENT_ID" and place this value inside your env as BITRIX_BOT_CLIENT_ID.

Usage

Now you can create a simple notification as follows:

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;
use PascalLieverse\Bitrix24\Bitrix24Channel;
use PascalLieverse\Bitrix24\Bitrix24Message;

class BitrixNotice extends Notification
{

    /**
     * Create a new notification instance.
     */
    public function __construct()
    {
    }

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [Bitrix24Channel::class];
    }

    /**
     * Get the message.
     *
     * @param  mixed  $notifiable
     * @return Bitrix24Message
     */
    public function toBitrix24($notifiable)
    {
        return (new Bitrix24Message())->text("Bitrix notification message!");
    }
}

The notification channel expects the user or chat ID to be passed. For example if the bitrix user ID is 1:

Notification::send(new Bitrix24Notifiable('1'), new BitrixNotice());

Or if the chat ID is 1:

Notification::send(new Bitrix24Notifiable('chat1'), new BitrixNotice());

License

MIT License (MIT). Freely redistributable product.