PingBell Real-Time Notifications
byte8/module-pingbell
Sends real-time push notifications to PingBell for key store events including new orders, invoices, shipments, credit memos, and customer registrations. Supports per-event bell configuration with encrypted API key storage.
Build Tests
Code Quality
Tested on Magento 2.4.8-p4
Recent Test History
Each release is tested against the latest Magento version at that time.
Top Contributors
View LeaderboardShare This Module's Status
README
Loaded from GitHubByte8_PingBell — Real-Time Notifications for Magento 2
A Magento 2 module that sends real-time notifications to PingBell for key store events — new orders, invoices, shipments, credit memos, and customer registrations.
Get instant push notifications on your phone, desktop, or smartwatch — no email delays, no dashboard refreshing.
Features
- Notifications for multiple events: orders, invoices, shipments, credit memos, and customer registrations
- Each event can notify a different PingBell
- Encrypted API key storage using Magento's built-in encryption
- "Fetch Bells" button per event to select from your PingBell accounts
- Dedicated log file (
var/log/pingbell.log) for easy debugging - Fully non-blocking — checkout and other flows are never affected if the PingBell API is unreachable
Requirements
- Magento 2.4.x
- PHP 8.1+
- A PingBell account and API key
Setting Up Your PingBell Account
- Go to pingbell.io and create an account
- Once logged in, create a bell for each event you want to track (e.g. "New Orders", "Shipments", "New Customers")
- To find your API Key, go to your account settings at app.pingbell.io
- To find a bell's PingBell ID, open the bell in your dashboard — the ID is the
idparameter in the URL, e.g.https://app.pingbell.io/log?id=Ljgkg6if7Tbx6x0n6jiv→ the ID isLjgkg6if7Tbx6x0n6jiv - Install the PingBell app on your phone or enable browser/desktop notifications to receive alerts
Installation
Composer (recommended)
composer require byte8/module-pingbell
bin/magento module:enable Byte8_PingBell
bin/magento setup:upgrade
bin/magento cache:flush
Manual
- Copy the module files to
app/code/Byte8/PingBell/ - Run:
bin/magento module:enable Byte8_PingBell
bin/magento setup:upgrade
bin/magento cache:flush
Configuration
Navigate to Stores > Configuration > Byte8 > PingBell Notifications.
General Settings
| Field | Description |
|---|---|
| Enable PingBell Notifications | Turn the module on or off |
| API Key | Your PingBell API key (stored encrypted) |
Event Notifications
Each event has its own Fetch Bells button and PingBell ID field. Leave the PingBell ID empty to skip notifications for that event.
| Event | Magento Trigger | Description |
|---|---|---|
| New Order | sales_order_place_after |
Customer completes checkout |
| New Invoice | sales_order_invoice_save_after |
Invoice is created |
| New Shipment | sales_order_shipment_save_after |
Shipment is created |
| New Credit Memo | sales_order_creditmemo_save_after |
Credit memo is created |
| New Customer | customer_register_success |
New customer registers |
Setup Steps
- Set Enable PingBell Notifications to Yes
- Enter your API Key from app.pingbell.io and Save Config
- Scroll to the Event Notifications section
- For each event you want to monitor:
- Click Fetch Bells to load your available bells
- Select a bell from the dropdown (this auto-fills the PingBell ID field), or paste the ID manually
- Save Config
- Place a test order (or trigger the relevant event) to verify notifications arrive
Logging
All PingBell activity is logged to:
var/log/pingbell.log
License
MIT — see LICENSE.txt for details.
This content is fetched directly from the module's GitHub repository. We are not the authors of this content and take no responsibility for its accuracy, completeness, or any consequences arising from its use.