Laravel SDK

Setup & Initialization

1. Install Package:

To install the Laravel Server SDK you may need to set your composer.json’s "minimum-stability" field to "dev", then:

composer require notificationapi/notificationapi-laravel-server-sdk:@dev

Or, if you prefer to keep your composer.json’s "minimum-stability" field set to "stable", then:

composer require notificationapi/notificationapi-php-server-sdk:@dev

composer require notificationapi/notificationapi-laravel-server-sdk:@dev -W

2. Register the NotificationApiServiceProvider:

For Laravel 9 or 10 add the service provider to config/app.php.

'providers' => [
	// ...
	NotificationAPI\NotificationApiServiceProvider::class,
]

For Laravel 11 add the service provider to bootstrap/providers.php.

return [
	// ...
	NotificationAPI\NotificationApiServiceProvider::class,
]

3. Add NotificationAPI keys to .env:

NOTIFICATION_API_KEY=clientID
NOTIFICATION_API_SECRET=clientSecret

No region variable is required for US region, but if using the CA (Canada) region add:

NOTIFICATION_API_REGION=CA

Or, if using the EU (Europe) region add:

NOTIFICATION_API_REGION=EU

4. Add this class to Models/NotificationUser.php for creating a user:

<?php

namespace App\Models;

use Illuminate\Notifications\Notifiable;

class NotificationUser
{
    use Notifiable;

    /**
     * The user's ID.
     *
     * @var string
     */
    public $id;

    /**
     * The user's email address.
     *
     * @var string
     */
    public $email;

    /**
     * The user's phone number.
     *
     * @var string
     */
    public $number;

    /**
     * Create a new notification user instance.
     *
     * @return void
     */
    public function __construct()
    {
        // Empty constructor to allow property assignment
    }

    /**
     * Route notifications for the notification-api channel.
     *
     * @return string
     */
    public function routeNotificationForNotificationApi()
    {
        return $this->id;
    }
}

5. Generate Notification class:

php artisan make:notification MyNotification

6. Update the Notification class:

class MyNotification extends Notification
{
    // ...

    protected $parameters;

     /**
     * Create a new notification instance.
     */
    public function __construct($parameters = null)
    {
        $this->parameters = $parameters;
    }

    // Update existing via function
    public function via($notifiable)
    {
        // Add to or replace existing values (e.g. 'mail')
        return ['notification-api'];
    }

    public function toNotificationApi($notifiable)
    {
        return [
            "type" => "my_notification_id",
            "to" => [
                "id" => $notifiable->getAttribute('id'),
                "email" => $notifiable->getAttribute('email'),
            ],
            "parameters" => $this->parameters
        ];
    }
}

* required

Send

Used to send a notification to the specified user.

Pass content directly without templates

You can ignore the templates and pass the content directly through the API by specifying channel content objects on the request.

$user = new NotificationUser();
$user->id = "spongebob.squarepants";
$user->email = "spongebob@squarepants.com";
$user->number = "+15005550006";

$user->notify(new MyNotification([
    "type" => "order_tracking",
    "email" => [
      "subject" => "Your Krabby Patty Order is Ready!",
      "html" => "<h1>Order Update</h1><p>Your order is ready for pickup!</p>",
      "senderName" => "Krusty Krab",
      "senderEmail" => "orders@krustykrab.com"
    ],
    "sms" => [
      "message" => "Your Krabby Patty order is ready for pickup!"
    ],
    "inapp" => [
      "title" => "Order Update",
      "image" => "https://example.com/image.png",
      "url" => "https://example.com"
    ],
    "web_push" => [
      "title" => "Order Update",
      "message" => "Your Krabby Patty order is ready for pickup!",
      "icon" => "https://example.com/icon.png",
      "url" => "https://example.com"
    ],
    "mobile_push" => [
      "title" => "Order Update",
      "message" => "Your Krabby Patty order is ready for pickup!"
    ],
    "slack" => [
      "text" => "Your Krabby Patty order is ready for pickup!"
    ]
]));

With templates and parameters

Use templates you designed in the Dashboard and inject dynamic values with parameters. The server renders your templates per-channel using the values you provide.

This example will send notifications over the channels and templates specified in our dashboard:

The notificationapi-laravel-server-sdk package uses Laravel’s notifications. Add this code to your project to send a notification:

<?php

use App\Models\NotificationUser;
use App\Notifications\MyNotification;

$user = new NotificationUser();
$user->id = "test_user_id";
$user->email = "spongebob@squarepants.com";
$user->number = "+15005550006";


// Optional parameters to customize the notification
$parameters = [
  "item" => "Krabby Patty Burger",
  "address" => "124 Conch Street"
  "commentId" => "1234567890"
];

// Send the notification to the user
$user->notify(new MyNotification($parameters));

// If you don't have parameters, you can simply call:
// $user->notify(new MyNotification());

:::info Alternatively you can send a notification without using Laravel’s notifications: :::

$data = [
  "type" => "my_notification_id",
  "to" => [
    "id" => "test_user_id",
    "email" => "spongebob@squarepants.com",
    "number" => "+15005550006"
  ],
  "parameters" => [
    "item" => "Krabby Patty Burger",
    "address" => "124 Conch Street",
    "commentId" => "1234567890"
  ]
];

$result = notification_api($data);
#or
$result = (new NotificationApiService)->send($data)

Parameters

The send() method accepts an object with the following fields:

Options Object

Size Limitation

When using parameters (merge tags) in the body of your notifications, it is recommended that the size of the combined parameters not exceed 150 KB. Exceeding this limit may result in delivery failure, or an API error.