Sending notifications | laravel-backup | Spatie

 SPATIE

  Laravel Backup
=================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-backup](https://spatie.be/docs/laravel-backup/v4)  Sending-notifications  Sending notifications

 Version   v10   v9   v8   v7   v6   v5   v4   v3

 Other versions for crawler [v10](https://spatie.be/docs/laravel-backup/v10) [v9](https://spatie.be/docs/laravel-backup/v9) [v8](https://spatie.be/docs/laravel-backup/v8) [v7](https://spatie.be/docs/laravel-backup/v7) [v6](https://spatie.be/docs/laravel-backup/v6) [v5](https://spatie.be/docs/laravel-backup/v5) [v4](https://spatie.be/docs/laravel-backup/v4) [v3](https://spatie.be/docs/laravel-backup/v3)

- [ Introduction ](https://spatie.be/docs/laravel-backup/v4/introduction)
- [ Postcardware ](https://spatie.be/docs/laravel-backup/v4/postcardware)
- [ Requirements ](https://spatie.be/docs/laravel-backup/v4/requirements)
- [ High level overview ](https://spatie.be/docs/laravel-backup/v4/high-level-overview)
- [ Installation and setup ](https://spatie.be/docs/laravel-backup/v4/installation-and-setup)
- [ Questions &amp; issues ](https://spatie.be/docs/laravel-backup/v4/questions-and-issues)
- [ Changelog ](https://spatie.be/docs/laravel-backup/v4/changelog)
- [ About us ](https://spatie.be/docs/laravel-backup/v4/about-us)

Taking Backups
--------------

- [ Taking backups ](https://spatie.be/docs/laravel-backup/v4/taking-backups/overview)
- [ Events ](https://spatie.be/docs/laravel-backup/v4/taking-backups/events)

Cleaning up old backups
-----------------------

- [ Cleaning up old backups ](https://spatie.be/docs/laravel-backup/v4/cleaning-up-old-backups/overview)
- [ Events ](https://spatie.be/docs/laravel-backup/v4/cleaning-up-old-backups/events)

Monitoring the health of all backups
------------------------------------

- [ Events ](https://spatie.be/docs/laravel-backup/v4/monitoring-the-health-of-all-backups/events)
- [ Monitoring the health of all backups ](https://spatie.be/docs/laravel-backup/v4/monitoring-the-health-of-all-backups/overview)

Sending notifications
---------------------

- [ Sending notifications ](https://spatie.be/docs/laravel-backup/v4/sending-notifications/overview)
- [ Adding extra notification channels ](https://spatie.be/docs/laravel-backup/v4/sending-notifications/adding-extra-notification-channels)
- [ Customizing the notifiable ](https://spatie.be/docs/laravel-backup/v4/sending-notifications/customizing-the-notifiable)

Advanced Usage
--------------

- [ Adding extra files to a backup ](https://spatie.be/docs/laravel-backup/v4/advanced-usage/adding-extra-files-to-a-backup)
- [ Backing up a non-laravel application ](https://spatie.be/docs/laravel-backup/v4/advanced-usage/backing-up-a-non-laravel-application)

      You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command:

 `                                    composer show spatie/laravel-backup                                                                                                                                                                                                                                    `

Sending notifications
=====================

###  On this page

1. [ Configuration ](#content-configuration)

The package leverages Laravel 5.3's native notifications to let you know that your backups are ok, or not. Out of the box it can send notifcations via mail and Slack (for Slack you'll need to require `guzzlehttp/guzzle` in your project).

Configuration
-----------------------------------------------------------------------------------------------

This is the portion of the configuration that will determine when and how notifications will be sent.

```
//config/laravel-backup.php

    /*
     * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
     * For Slack you need to install guzzlehttp/guzzle.
     *
     * You can also use your own notification classes, just make sure the class is named after one of
     * the `Spatie\Backup\Events` classes.
     */
    'notifications' => [

        'notifications' => [
            \Spatie\Backup\Notifications\Notifications\BackupHasFailed::class         => ['mail'],
            \Spatie\Backup\Notifications\Notifications\UnhealthyBackupWasFound::class => ['mail'],
            \Spatie\Backup\Notifications\Notifications\CleanupHasFailed::class        => ['mail'],
            \Spatie\Backup\Notifications\Notifications\BackupWasSuccessful::class     => ['mail'],
            \Spatie\Backup\Notifications\Notifications\HealthyBackupWasFound::class   => ['mail'],
            \Spatie\Backup\Notifications\Notifications\CleanupWasSuccessful::class    => ['mail'],
        ],

        /*
         * Here you can specify the notifiable to which the notifications should be sent. The default
         * notifiable will use the variables specified in this config file.
         */
        'notifiable' => \Spatie\Backup\Notifications\Notifiable::class,

        'mail' => [
            'to' => 'your@email.com',
        ],

        'slack' => [
            'webhook_url' => '',
        ],
    ],

```
