This is the documentation for
v3 but the latest version is
v8
.
You can switch versions in the menu on the left/at the top.
Check your current version with the following command:
composer show spatie/laravel-backup
By default the backup package can notify you by:
- writing something in the log
- by sending a mail
- if
maknz/slack
is installed, posting a message on Slack
If you want to be notified via another channel you can create your own sender. A valid sender is any object that implements the Spatie\Backup\Notifications\SendsNotifications
-interface.
namespace Spatie\Backup\Notifications;
interface SendsNotifications
{
/**
* @param string $type
*
* @return \Spatie\Backup\Notifications\SendsNotifications
*/
public function setType($type);
/**
* @param string $subject
*
* @return \Spatie\Backup\Notifications\SendsNotifications
*/
public function setSubject($subject);
/**
* @param string $message
*
* @return \Spatie\Backup\Notifications\SendsNotifications
*/
public function setMessage($message);
public function send();
}
If you choose to extend Spatie\Backup\Notifications\BaseSender
you'll only need to implement the send
-function.
Your custom sender can be used by specifying it's full class name in one the monitor.events
-keys in the laravel-backup config file.
// ...
'whenBackupHasFailed' => ['log', 'mail', App\Backup\MyCustomSender::class],
// ...
When you've created a sender that could be beneficial to the community, consider contributing the code to this package.