WP Down Slack Alert Plugin
Connect WordPress Recovery Mode to a your Slack team to receive alerts when websites are down.
This plugin is meant to send automatic notifications on the channel of your choice in your Slack Team.
Wether you manage hundred of websites or only a single one, it’s always good to know when they are down, so you can step in as quick as possible.
WP Down Slack Alert provides a dedicated settings screen where you are able to set up your Slack channel configuration and to create a customized bot (name, avatar…) for your notifications. There is a very helpful configuration wizard for your Slack API token. It will only takes few minutes to complete the configuration process.
You can also programmatically define the plugin’s settings with dedicated PHP constants (see FAQ section below).
This plugin is based on WordPress Core Recovery Mode. The Slack alert is triggered when your websites goes into Recovery Mode and send you a Slack Notification with details about the issue.
Installation
- Install the plugin and activate.
- Go to Tools > WP Down Slack Alert settings.
- See our FAQ below or follow the instruction in the settings page to configure your Slack token.
Screenshots
Settings screen.
Slack API Token tutorial in the settings screen.
Slack notification example.
FAQ
Go to Tools > WP Down Slack Alert and follow the tutorial to get your Slack API token and customize your Slack notification bot:
To set up your Slack app, you’ll need to get a Slack Bot token:
- Go to this page: https://api.slack.com/apps?new_app=1 and provide a name for your App, choose a Slack workspace and click on “Create App” button.
- In the “Features and functionality” section, click on the “Bots” panel.
- That will lead you to the “Bot user” screen. Click on “Add a Bot User” button.
- Leave the default names (you will be able to override that in the plugin’s settings), and click “Add bot user” button.
- Click on the “Install App” menu item in the navigation sidebar, then click on the “Install App to Workspace” button.
- Allow this Slack App to access your Slack team: click on the “Allow” button.
- Copy/paste the Bot User OAuth Access Token in the plugin’s settings field.
To programmatically define your settings, you can optionally use the following PHP constants, in a customized mu-plugin:
// Disable the admin settings screen (false to disable) define( 'WPDSA_SETTINGS', false ); // Define the Slack API Token (string) define( 'WPDSA_NOTIFICATION_TOKEN', 'qcsqkjcssjcksqh' ); // Define the notification channel (string - slugified) define( 'WPDSA_NOTIFICATION_CHANNEL', 'my_slack_channel' ); // Disable the notification email (true to disable) define( 'WPDSA_NOTIFICATION_DISABLE_EMAIL', true ); // Define the Slack notification recurrence (string - accepted values: '0,5', '1', '2', '6', '24', 'anytime') define( 'WPDSA_NOTIFICATION_RECURRENCE', '2' ); // Define the notification bot name (string - slugified) define( 'WPDSA_NOTIFICATION_BOTNAME', 'My_bot_name' ); // Define the notification message title text (string) define( 'WPDSA_NOTIFICATION_MESSAGE_TITLE', 'My message title' ); // Define the notification message footer text (string) define( 'WPDSA_NOTIFICATION_MESSAGE_FOOTER', 'My message footer text' ); // Define the notification message image (string - absolute link to an online image) define( 'WPDSA_NOTIFICATION_MESSAGE_IMAGE', 'http://assets.whodunit.fr/brand/logo_whodunit_petit.png' ); // Disable the "Green" notification message (true to disable) define( 'WPDSA_NOTIFICATION_DISABLE_GREEN', true ); Follow this link to download a complete example of mu-plugin file
You can download it, change the constants values if needed and upload it to /wp-content/mu-plugins folder. You can also define the PHP constants in your wp-config.php file.
Changelog
0.4.1
- Technical fixes.
0.4
- New feature: send a Green notification when a broken website is back in business.
- Enhancement: Add disable green notification setting.
- Enhancement: Add disable green notification constant.
0.3.2
- Fix: false positive with Slack API connexion check.
0.3.1
- Fix: possible PHP fatal error on notification frequency.
- Fix: Remove a test echo function in plugin’s main file.
0.3
- Fix: styles and scripts enqueues.
- Fix: possible PHP fatal error for old PHP versions.
- Enhancement: add a set of PHP constants to programmatically define the plugin settings.
0.2
- Better internationalization and tutorial integration.
0.1
- Plugin initial commit. Works fine 🙂