# Webex Notifications Channel for Laravel

(opens new window) (opens new window) (opens new window) (opens new window)

This package makes it easy to send notifications using Webex (opens new window) with Laravel 10 and 11.

/**
 * Get the Webex Message representation of the notification.
 *
 * @return \NotificationChannels\Webex\WebexMessage
 *
 * @throws \NotificationChannels\Webex\Exceptions\CouldNotCreateNotification
 */
public function toWebex(mixed $notifiable)
{
    return (new WebexMessage)
        ->text('The message, in plain text.')
        ->markdown('# The message, in Markdown format.')
        ->file(function (WebexMessageFile $file) {
            $file->path('https://www.webex.com/content/dam/wbx/global/images/webex-favicon.png');
        });
}

# Contents

Installation
- Install the package using Composer
- Add service configuration for Webex
Usage
- Formatting Webex Notifications
- Routing Webex Notifications
Available Methods
Changelog
Testing
Security
Contributing
Credits
License

# Installation

To use this package, you need to add it as a dependency to your project and provide the necessary configuration.

# Install the package using Composer

Pull in and manage the Webex notifications package easily with Composer:

composer require laravel-notification-channels/webex

# Add service configuration for Webex

You will also need to include a Webex service configuration to your application. To do this, edit the config/services.php file, and add the following, or if the webex key already exists, merge:

'webex' => [
    'notification_channel_url' => env('WEBEX_NOTIFICATION_CHANNEL_URL', 'https://webexapis.com/v1/messages'),
    'notification_channel_id' => env('WEBEX_NOTIFICATION_CHANNEL_ID'),
    'notification_channel_token' => env('WEBEX_NOTIFICATION_CHANNEL_TOKEN')
],

Use the WEBEX_NOTIFICATION_CHANNEL_ID and WEBEX_NOTIFICATION_CHANNEL_TOKEN environment variables (opens new window) to define your Webex ID and Token. One way to get these values is by creating a new Webex Bot (opens new window).

# Usage

If you are new to Laravel Notification, I highly recommend reading the official documentation which goes over the basics of generating (opens new window) and sending (opens new window) notifications. The guide below assumes that you have successfully generated a notification class with a via (opens new window) method whose return value includes 'webex' or NotificationChannels\Webex\WebexChannel::class. For example:

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use NotificationChannels\Webex\WebexChannel;

class InvoicePaid extends Notification
{
    use Queueable;

    // ...

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

    // ...
}

To send notifications on Webex, define a toWebex method on the notification class and a routeNotificationForWebex method on the notifiable entity. These steps are discussed below.

# Formatting Webex Notifications

If a notification supports being sent as a Webex message, you should define a toWebex method on the notification class. This method will receive a $notifiable entity and should return a \NotificationChannels\Webex\WebexMessage instance. Webex messages may contain text content as well as at most one file or an attachment ( for buttons and cards (opens new window)).

# Plain Text Message

Let's take a look at a basic toWebex example, which we could add to our InvoicePaid class above.

public function toWebex(mixed $notifiable): WebexMessage
{
    return (new WebexMessage)
        ->text('Invoice Paid!');
}