Laravel quickstart

Install and configure the Pushctl Laravel SDK and send your first notification.

The package supports PHP 8.3+ and Laravel 12 or 13.

1. Install the package

   composer require pushctl/pushctl-laravel
   
2. Configure a Server send token

   PUSHCTL_TOKEN=push_live_your_server_token
   

   The default service URL is https://pushctl.com and the default timeout is 10 seconds.

3. Create a Laravel notification

   use Illuminate\Notifications\Notification;
   use Pushctl\PushctlLaravel\Channels\PushctlChannel;
   use Pushctl\PushctlLaravel\Messages\PushctlMessage;
   
   final class OrderReady extends Notification
   {
       public function __construct(private readonly Order $order) {}
   
       public function via(object $notifiable): array
       {
           return [PushctlChannel::class];
       }
   
       public function toPushctl(object $notifiable): PushctlMessage
       {
           return PushctlMessage::create(
               'Order ready',
               'Your order is ready for collection.',
           )->actionUrl("myapp://orders/{$this->order->id}");
       }
   }
   
4. Route the recipient

   use Illuminate\Notifications\Notification;
   
   public function routeNotificationForPushctl(Notification $notification): string|array
   {
       return $this->pushctl_user_id;
   }
   
5. Dispatch through Laravel

   $user->notify(new OrderReady($order));
   

Keep PUSHCTL_TOKEN in the server environment. Do not commit it or expose it to browser or mobile code.