Signalgrid WordPress plugin documentation.
Signalgrid adds a small integration layer to WordPress so your code can send push notifications through Signalgrid.
After you enter your Client Key in the admin settings, you can call a single PHP function to dispatch a notification
to a target channel.
Prerequisites
- A Signalgrid account
- A Signalgrid Client Key for authentication
- A Signalgrid channel token to receive notifications
- WordPress with outbound HTTP access so your server can reach the Signalgrid API
Installation
- Install the plugin via Plugins → Add New and search for Signalgrid, or upload it manually to
/wp-content/plugins/ - Activate it via Plugins
- Open Signalgrid in the WordPress admin menu
- Paste your Client Key and save
Configuration
Configuration is intentionally simple. In the WordPress admin area, open the plugin settings page and enter your Signalgrid Client Key. This key is used to authenticate notification requests made through the plugin.
Notification routing is controlled per call by providing a channel value to the function.
This means you can send different notifications to different channels depending on the use case.
PHP API
The plugin exposes a global function that can be called from themes or other plugins. Use it inside hooks, cron tasks, or custom business logic whenever you want to send a notification.
How to use the function
signalgrid_notify(
string $channel,
string $title,
string $body,
string $severity,
bool $critical
): boolParameters
$channel: Destination channel token$title: Short title text$body: Main message content$severity: Severity label such asINFO,WARN, orCRIT$critical: Marks the notification as critical/high priority
Return value
Returns true if the plugin reports the request was accepted, otherwise false.
Treat false as a send failure and log details in your application.
Usage examples
Basic call
<?php
$channel = 'YOUR_CHANNEL_TOKEN';
$title = 'Job finished';
$body = 'The nightly import completed successfully.';
$severity = 'INFO';
$critical = false;
$ok = signalgrid_notify($channel, $title, $body, $severity, $critical);
if ( ! $ok ) {
error_log('Signalgrid notification failed to send.');
}
?>
Send a notification when a scheduled task fails
<?php
add_action('myplugin_nightly_task_failed', function( $error_message ) {
$channel = 'YOUR_CHANNEL_TOKEN';
$title = 'Nightly task failed';
$body = $error_message;
$severity = 'CRIT';
$critical = true;
signalgrid_notify($channel, $title, $body, $severity, $critical);
});
?>
Notify on repeated login failures
<?php
add_action('wp_login_failed', function( $username ) {
$key = 'sg_failed_logins_' . md5($username . '|' . wp_get_session_token());
$count = (int) get_transient($key);
$count++;
set_transient($key, $count, 10 * MINUTE_IN_SECONDS);
if ( $count >= 5 ) {
$channel = 'YOUR_CHANNEL_TOKEN';
$title = 'Multiple login failures';
$body = 'Username: ' . $username . ' — ' . $count . ' failures in 10 minutes.';
$severity = 'WARN';
$critical = false;
signalgrid_notify($channel, $title, $body, $severity, $critical);
}
});
?>