Create your own webhook mechanism with Laravel notification.

Sunday, 15/12/2019

Tram Ho

Preamble

Today I will show you how to create your own webhook mechanism. we have known for a long time and use the webhook function of github, facebook … They kind of let me enter a Payload URL and select the event so that when the event happens, github will also send http request to Payload URL of the user.

Similarly, in this demo we will allow users to enter their webhook url. and when there is an event on our system, the system also proceeds to send http requests to their url (request including body and header).

What is webhook?

Install Dependencies

First we need to install the package for sending HTTP requests. Here I use quite popular library is Guzzle:

composer require guzzlehttp/guzzle:~6.0

1 2	composer require guzzlehttp/guzzle:~6.0

Data migration

Next we create the user table. In this demo, I will save name , email , password , api_token and especially have the webhook_url field which is the user’s enpoint when registering Webhook End Point on our system.

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

<span class="token keyword">use</span> <span class="token package">Illuminate  Support  Facades  Schema</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Database  Schema  Blueprint</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Database  Migrations  Migration</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 Illuminate Support Facades Schema ;

use Illuminate Database Schema Blueprint ;

use Illuminate Database Migrations Migration ;

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' ) ;

}

Create a model

Next is to create the User model

<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">Illuminate  Notifications  Notifiable</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Foundation  Auth  User</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 Illuminate Notifications Notifiable ;

use Illuminate Foundation Auth User 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 ;

}

This model is quite easy to understand. I have 2 more functions getSigningKey and getWebhookUrl to get api_key and webhook_url

Create notification channels

Next we need to create a notification channel. Then laravel support us create as well as custom notification channels here .

Proceed to create 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">App  Channels</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">GuzzleHttp  Client</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Log  Logger</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Notifications  Notifiable</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Notifications  Notification</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 App Channels ;

use GuzzleHttp Client ;

use Illuminate Log Logger ;

use Illuminate Notifications Notifiable ;

use Illuminate Notifications Notification ;

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 )

{

}

The send function is where we write the code to make the send http request to the user’s endpoint (webhook_url).

Next I proceed to write the send function

Firstly ,

<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 ( ) ) ;

}

That’s it, 1 notification channels. Next, I just need to call Webhook notification and use it.

Make webhook notification

Next we create the notification by command

php artisan make:notification SomethingHappenedNotification

1 2	php artisan make:notification SomethingHappenedNotification

Proceed to write the 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">App  Notifications</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">App  Channels  WebhookChannel</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Bus  Queueable</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Notifications  Notification</span> <span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate  Contracts  Queue  ShouldQueue</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 App Notifications ;

use App Channels WebhookChannel ;

use Illuminate Bus Queueable ;

use Illuminate Notifications Notification ;

use Illuminate Contracts Queue ShouldQueue ;

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 That’s it! Now we can create events and send notifications to the endpoint that the user has registered.

<span class="token keyword">use</span> <span class="token package">App  Notifications  SomethingHappenedNotification</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 App Notifications SomethingHappenedNotification ;

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

Conclude

Thank you for reading here.

Reference: https://laravel.com/docs/5.6/notifications#custom-channels ,

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

Share the news now

Source : Viblo

Create your own webhook mechanism with Laravel notification.

Preamble

What is webhook?

Install Dependencies

Data migration

Create a model

Create notification channels

Make webhook notification

Conclude

TikTok becomes the second largest social platform in South Africa

The fastest depreciating after 9 months of launch, iPhone 14 Pro Max continues to break the bottom in Vietnam

Beginner's guide to R: Introduction

10 essential SublimeText plugins for JavaScript developers