Tạo mechanism webhook cho riêng mình với Laravel notification.

Chủ Nhật, 15/12/2019

Tram Ho

Mở đầu

Hôm nay mình sẽ hướng dẫn cho các bạn cách tạo một webhook mechanism cho riêng mình. từ lâu chúng ta đã biểt đến và dùng chức năng webhook của github, facebook … .Đại loại là họ sẽ cho mình nhập 1 Payload URL và chọn sự kiện để khi có sự kiện đó thì github cũng send http request đến Payload URL của người dùng.

Tương tự vậy, ở demo nay chúng ta sẽ cho phép người dùng nhập webhook url của họ. và khi có 1 sự kiện nào đó trên hệ thống chúng ta thì hệ thống cũng tiến hành send http request đến url của họ (request gồm body và header).

Webhook là gì?

Cài đặt Dependencies

Đầu tiên chúng ta cần cài đặt package để cho việc gửi HTTP request. Ở đây mình dùng thư viện khá phổ biến là Guzzle:

composer require guzzlehttp/guzzle:~6.0

1 2	composer require guzzlehttp/guzzle:~6.0

Migrate dữ liệu

Tiếp theo chúng ta tạo bảng user. ở ví dụ demo này thì mình sẽ lưu name, email, password, api_token và đặc biệt có thêm trường webhook_url đây chính là enpoint của người dùng khi đăng ký Webhook End Point trên hệ thống của chúng ta.

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>

<span class="token keyword">use</span> <span class="token package">IlluminateSupportFacadesSchema</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateDatabaseSchemaBlueprint</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateDatabaseMigrationsMigration</span><span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">CreateUsersTable</span> <span class="token keyword">extends</span> <span class="token class-name">Migration</span>
<span class="token punctuation">{</span>
    <span class="token comment">/**
     * Run the migrations.
     *
     * @return void
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">up</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        Schema<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'users'</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span>Blueprint <span class="token variable">$table</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">increments</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'id'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'name'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'email'</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">unique</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'password'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'api_key'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">string</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'webhook_url'</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">nullable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">rememberToken</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token variable">$table</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">timestamps</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
        <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * Reverse the migrations.
     *
     * @return void
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">down</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        Schema<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token function">dropIfExists</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'users'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

</span>

<?php

use IlluminateSupportFacadesSchema;

use IlluminateDatabaseSchemaBlueprint;

use IlluminateDatabaseMigrationsMigration;

class CreateUsersTable extends Migration

{

/**

* Run the migrations.

* @return void

*/

public function up()

{

Schema::create('users', function (Blueprint $table) {

$table->increments('id');

$table->string('email')->unique();

$table->string('webhook_url')->nullable();

$table->rememberToken();

$table->timestamps();

});

}

/**

* Reverse the migrations.

* @return void

*/

public function down()

{

Schema::dropIfExists('users');

}

Tạo model

Tiếp theo là tạo model User

<span class="token keyword">namespace</span> <span class="token package">App</span><span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">IlluminateNotificationsNotifiable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateFoundationAuthUser</span> <span class="token keyword">as</span> Authenticatable<span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token keyword">extends</span> <span class="token class-name">Authenticatable</span>
<span class="token punctuation">{</span>
    <span class="token keyword">use</span> <span class="token package">Notifiable</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * The attributes that are mass assignable.
     *
     * @var array
     */</span>
    <span class="token keyword">protected</span> <span class="token variable">$fillable</span> <span class="token operator">=</span> <span class="token punctuation">[</span>
        <span class="token single-quoted-string string">'name'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'email'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'password'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'api_key'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'webhook_url'</span><span class="token punctuation">,</span>
    <span class="token punctuation">]</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */</span>
    <span class="token keyword">protected</span> <span class="token variable">$hidden</span> <span class="token operator">=</span> <span class="token punctuation">[</span>
        <span class="token single-quoted-string string">'password'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'remember_token'</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'api_key'</span><span class="token punctuation">,</span>
    <span class="token punctuation">]</span><span class="token punctuation">;</span>
    
    <span class="token comment">/**
     * @return string
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getSigningKey</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">api_key</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

    <span class="token comment">/**
     * @return string
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">getWebhookUrl</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">webhook_url</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

namespace App;

use IlluminateNotificationsNotifiable;

use IlluminateFoundationAuthUser as Authenticatable;

class User extends Authenticatable

{

use Notifiable;

/**

* The attributes that are mass assignable.

* @var array

*/

protected $fillable = [

'name', 'email', 'password', 'api_key', 'webhook_url',

];

/**

* The attributes that should be hidden for arrays.

* @var array

*/

protected $hidden = [

'password', 'remember_token', 'api_key',

];

/**

* @return string

*/

public function getSigningKey()

{

return $this->api_key;

}

/**

* @return string

*/

public function getWebhookUrl()

{

return $this->webhook_url;

}

Model này khá dễ hiểu rồi. mình có thêm 2 hàm getSigningKey và getWebhookUrl để lấy api_key và webhook_url

Tạo notification channels

Tiếp theo chúng ta cần tạo 1 notification channel. Thì laravel có hỗ trợ chúng ta tạo cũng như custom notification channels ở Tại đây.

Tiến hành tạo WebhookChannel

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
<span class="token keyword">namespace</span> <span class="token package">AppChannels</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">GuzzleHttpClient</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateLogLogger</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateNotificationsNotifiable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateNotificationsNotification</span><span class="token punctuation">;</span>
<span class="token keyword">class</span> <span class="token class-name">WebhookChannel</span>
<span class="token punctuation">{</span>
    <span class="token comment">/**
     * @var Client
     */</span>
    <span class="token keyword">private</span> <span class="token variable">$client</span><span class="token punctuation">;</span>
    <span class="token comment">/**
     * @var Logger
     */</span>
    <span class="token keyword">private</span> <span class="token variable">$logger</span><span class="token punctuation">;</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">__construct</span><span class="token punctuation">(</span>Client <span class="token variable">$client</span><span class="token punctuation">,</span> Logger <span class="token variable">$logger</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">client</span> <span class="token operator">=</span> <span class="token variable">$client</span><span class="token punctuation">;</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">logger</span> <span class="token operator">=</span> <span class="token variable">$logger</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
    <span class="token comment">/**
     * @param Notifiable $notifiable
     * @param Notification $notification
     * @throws WebHookFailedException
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">send</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">,</span> Notification <span class="token variable">$notification</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>

</span>

<?php

namespace AppChannels;

use GuzzleHttpClient;

use IlluminateLogLogger;

use IlluminateNotificationsNotifiable;

use IlluminateNotificationsNotification;

class WebhookChannel

{

/**

* @var Client

*/

private $client;

/**

* @var Logger

*/

private $logger;

public function __construct(Client $client, Logger $logger)

{

$this->client = $client;

}

/**

* @param Notifiable $notifiable

* @param Notification $notification

* @throws WebHookFailedException

*/

public function send($notifiable, Notification $notification)

{

}

Function send là nơi chúng ta viết code để thực hiện việc send http request đến endpoint (webhook_url) của người dùng.

Tiếp theo mình tiến hành viết hàm send

Đầu tiên ,

<span class="token comment">/**
     * @param Notifiable $notifiable
     * @param Notification $notification
     * @throws WebHookFailedException
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">send</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">,</span> Notification <span class="token variable">$notification</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token function">method_exists</span><span class="token punctuation">(</span><span class="token variable">$notification</span><span class="token punctuation">,</span> <span class="token single-quoted-string string">'toWebhook'</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token variable">$body</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">array</span><span class="token punctuation">)</span> <span class="token variable">$notification</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">toWebhook</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
        <span class="token punctuation">}</span> <span class="token keyword">else</span> <span class="token punctuation">{</span>
            <span class="token variable">$body</span> <span class="token operator">=</span> <span class="token variable">$notification</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">toArray</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
        <span class="token punctuation">}</span>
        <span class="token variable">$timestamp</span> <span class="token operator">=</span> <span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">timestamp</span><span class="token punctuation">;</span>
        <span class="token variable">$token</span> <span class="token operator">=</span> <span class="token function">str_random</span><span class="token punctuation">(</span><span class="token number">16</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
        <span class="token comment">// Tạo header cho request webhook . cái này để người dùng có thể xác minh request gửi lên là từ hệ thống của chúng ta mà không phải từ hệ thông khác</span>
        <span class="token variable">$headers</span> <span class="token operator">=</span> <span class="token punctuation">[</span>
            <span class="token single-quoted-string string">'timestamp'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$timestamp</span><span class="token punctuation">,</span>
            <span class="token single-quoted-string string">'token'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$token</span><span class="token punctuation">,</span>
            <span class="token single-quoted-string string">'signature'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token function">hash_hmac</span><span class="token punctuation">(</span>
                <span class="token single-quoted-string string">'sha256'</span><span class="token punctuation">,</span>
                <span class="token variable">$token</span> <span class="token punctuation">.</span> <span class="token variable">$timestamp</span><span class="token punctuation">,</span>
                <span class="token variable">$notifiable</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getSigningKey</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
            <span class="token punctuation">)</span><span class="token punctuation">,</span>
        <span class="token punctuation">]</span><span class="token punctuation">;</span>
        
        <span class="token comment">// Tiếp theo chúng ta tạo 1 request sử dụng GuzzleHttp để gửi request</span>
        <span class="token variable">$request</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'POST'</span><span class="token punctuation">,</span> <span class="token variable">$notifiable</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getWebhookUrl</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$headers</span><span class="token punctuation">,</span> <span class="token function">json_encode</span><span class="token punctuation">(</span><span class="token variable">$body</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

        <span class="token keyword">try</span> <span class="token punctuation">{</span>
            <span class="token variable">$response</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">client</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">send</span><span class="token punctuation">(</span><span class="token variable">$request</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token comment">// kiểm tra nếu không nhận được status code = 200 thì sẽ báo lỗi</span>
            <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token variable">$response</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getStatusCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">!==</span> <span class="token number">200</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                <span class="token keyword">throw</span> <span class="token keyword">new</span> <span class="token class-name">WebHookFailedException</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Webhook received a non 200 response'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token punctuation">}</span>
            <span class="token comment">// Lưu lại log</span>
            <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">logger</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">debug</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Webhook successfully posted to '</span><span class="token punctuation">.</span> <span class="token variable">$notifiable</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getWebhookUrl</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

            <span class="token keyword">return</span><span class="token punctuation">;</span>

        <span class="token punctuation">}</span> <span class="token keyword">catch</span> <span class="token punctuation">(</span><span class="token class-name">ClientException</span> <span class="token variable">$exception</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token variable">$exception</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getResponse</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getStatusCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">!==</span> <span class="token number">410</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
                <span class="token keyword">throw</span> <span class="token keyword">new</span> <span class="token class-name">WebHookFailedException</span><span class="token punctuation">(</span><span class="token variable">$exception</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$exception</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$exception</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
            <span class="token punctuation">}</span>
        <span class="token punctuation">}</span> <span class="token keyword">catch</span> <span class="token punctuation">(</span><span class="token class-name">GuzzleException</span> <span class="token variable">$exception</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
            <span class="token keyword">throw</span> <span class="token keyword">new</span> <span class="token class-name">WebHookFailedException</span><span class="token punctuation">(</span><span class="token variable">$exception</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getMessage</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$exception</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getCode</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$exception</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
        <span class="token punctuation">}</span>

        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">logger</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">error</span><span class="token punctuation">(</span><span class="token single-quoted-string string">'Webhook failed in posting to '</span><span class="token punctuation">.</span> <span class="token variable">$notifiable</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">getWebhookUrl</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>

/**

* @param Notifiable $notifiable

* @param Notification $notification

* @throws WebHookFailedException

*/

{

if (method_exists($notification, 'toWebhook')) {

$body = (array) $notification->toWebhook($notifiable);

} else {

$body = $notification->toArray($notifiable);

}

$timestamp = now()->timestamp;

$token = str_random(16);

// Tạo header cho request webhook . cái này để người dùng có thể xác minh request gửi lên là từ hệ thống của chúng ta mà không phải từ hệ thông khác

$headers = [

'timestamp' => $timestamp,

'token' => $token,

'signature' => hash_hmac(

'sha256',

$token . $timestamp,

$notifiable->getSigningKey()

),

];

// Tiếp theo chúng ta tạo 1 request sử dụng GuzzleHttp để gửi request

$request = new Request('POST', $notifiable->getWebhookUrl(), $headers, json_encode($body));

try {

$response = $this->client->send($request);

// kiểm tra nếu không nhận được status code = 200 thì sẽ báo lỗi

if ($response->getStatusCode() !== 200) {

}

// Lưu lại log

$this->logger->debug('Webhook successfully posted to '. $notifiable->getWebhookUrl());

return;

} catch (ClientException $exception) {

if ($exception->getResponse()->getStatusCode() !== 410) {

throw new WebHookFailedException($exception->getMessage(), $exception->getCode(), $exception);

}

} catch (GuzzleException $exception) {

}

$this->logger->error('Webhook failed in posting to '. $notifiable->getWebhookUrl());

}

Vậy là xong 1 notification channels. Tiếp theo mình chỉ việc gọi Webhook notification và dùng thôi.

Thực hiện notification webhook

Tiếp theo chúng ta tạo notification bằng lệnh

php artisan make:notification SomethingHappenedNotification

1 2	php artisan make:notification SomethingHappenedNotification

Tiến hành viết code.

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
<span class="token keyword">namespace</span> <span class="token package">AppNotifications</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">AppChannelsWebhookChannel</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateBusQueueable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateNotificationsNotification</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">IlluminateContractsQueueShouldQueue</span><span class="token punctuation">;</span>
<span class="token keyword">class</span> <span class="token class-name">SomethingHappenedNotification</span> <span class="token keyword">extends</span> <span class="token class-name">Notification</span> <span class="token keyword">implements</span> <span class="token class-name">ShouldQueue</span>
<span class="token punctuation">{</span>
    <span class="token keyword">use</span> <span class="token package">Queueable</span><span class="token punctuation">;</span>
    <span class="token comment">/**
     * @var string
     */</span>
    <span class="token keyword">private</span> <span class="token variable">$message</span><span class="token punctuation">;</span>
    <span class="token comment">/**
     * Create a new notification instance.
     *
     * @param string $message
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">__construct</span><span class="token punctuation">(</span><span class="token variable">$message</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token comment">//</span>
        <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">message</span> <span class="token operator">=</span> <span class="token variable">$message</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
    <span class="token comment">/**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">via</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span>WebhookChannel<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token keyword">class</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toWebhook</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span>
            <span class="token single-quoted-string string">'message'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">message</span><span class="token punctuation">,</span>
        <span class="token punctuation">]</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
    <span class="token comment">/**
     * Get the array representation of the notification.
     *
     * @param  mixed  $notifiable
     * @return array
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toArray</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</span>

<?php

namespace AppNotifications;

use AppChannelsWebhookChannel;

use IlluminateBusQueueable;

use IlluminateNotificationsNotification;

use IlluminateContractsQueueShouldQueue;

class SomethingHappenedNotification extends Notification implements ShouldQueue

{

use Queueable;

/**

* @var string

*/

private $message;

/**

* Create a new notification instance.

* @param string $message

*/

public function __construct($message)

{

//

$this->message = $message;

}

/**

* Get the notification's delivery channels.

* @param mixed $notifiable

* @return array

*/

public function via($notifiable)

{

return [WebhookChannel::class];

}

public function toWebhook($notifiable)

{

return [

'message' => $this->message,

];

}

/**

* Get the array representation of the notification.

* @param mixed $notifiable

* @return array

*/

public function toArray($notifiable)

{

return [];

}

ok. vậy là đã xong . giờ chúng ta có thể tạo các sự kiện và send notification đến endpoint mà người dùng đã đăng ký.

<span class="token keyword">use</span> <span class="token package">AppNotificationsSomethingHappenedNotification</span><span class="token punctuation">;</span>

<span class="token variable">$user</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">notify</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">SomethingHappenedNotification</span><span class="token punctuation">(</span><span class="token variable">$massage</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

use AppNotificationsSomethingHappenedNotification;

$user->notify(new SomethingHappenedNotification($massage));

Kết luận

Cảm ơn các bạn đã đọc đến đây.

Tham khảo : https://laravel.com/docs/5.6/notifications#custom-channels,

Source code: https://github.com/phamtuananh1996/laravel-webhook-demo

Chia sẻ bài viết ngay

Nguồn bài viết : Viblo

Tạo mechanism webhook cho riêng mình với Laravel notification.

Mở đầu

Webhook là gì?

Cài đặt Dependencies

Migrate dữ liệu

Tạo model

Tạo notification channels

Thực hiện notification webhook

Kết luận

Đại diện tập thể bác sĩ tuyến đầu chống dịch Covid-19, So Y Tiet, song Nhi... và rất nhiều nhân vật truyền cảm hứng đã có mặt tại Gala WeChoice Awards 2020

Galaxy S21 series - smartphone giúp giới trẻ thể hiện cá tính và thông điệp bản thân trong năm 2021

10 plugin cần thiết của SublimeText dành cho các lập trình viên JavaScript

Hướng dẫn sử dụng ngôn ngữ R cho người mới bắt đầu