Skip to main content

​
Overview

PingPilot sends notifications to multiple channels when events occur. You can configure your notification preferences in the account settings to receive alerts via Discord, Telegram, WhatsApp, and email.
You must configure at least your Discord ID and Telegram username to receive event notifications. These are required fields checked before processing events.

​
Notification Channels

PingPilot supports four notification channels:

Discord

Receive rich embedded messages in Discord DMs

Telegram

Get instant text notifications via Telegram

Email

HTML formatted emails with event details

WhatsApp

SMS notifications to your WhatsApp number

​
Accessing Account Settings

1

Navigate to Dashboard

Log in and go to your PingPilot dashboard
2

Open Account Settings

Click on Account Settings in the sidebar
3

Configure Notification Preferences

Update your Discord ID, Telegram username, WhatsApp number, and email
4

Save Changes

Click Save to update your preferences

​
Discord Notifications

​
Finding Your Discord ID

1

Enable Developer Mode

Open Discord Settings > Advanced > Enable “Developer Mode”
2

Copy Your User ID

Right-click on your username anywhere in Discord and select “Copy User ID”
3

Add to PingPilot

Paste your Discord ID in the Account Settings page

​
Discord ID Format

Your Discord ID should be a numeric string like:
  • 123456789012345678
  • 987654321098765432
Your Discord ID is required to receive event notifications. The API will return a 403 error if your Discord ID is not set.

​
Discord Message Format

Discord notifications are sent as embedded messages with:
  • Title: Category emoji + capitalized category name
  • Description: Your event description
  • Color: Category color (color-coded border)
  • Timestamp: When the event occurred
  • Fields: All custom fields displayed inline
Example embed: 
╔══════════════════════════════
║ 🐛 Bug
║ 
║ Critical error in payment processor
║
║ severity: high        user_id: 12345
║ environment: production
║
║ Mar 06, 2024 at 10:30 AM
╚══════════════════════════════

​
Discord Bot Setup

PingPilot uses a Discord bot to send direct messages. When you first receive a notification:
  1. The bot creates a DM channel with you
  2. Messages are sent directly to your DMs
  3. You don’t need to be in a server with the bot
Make sure your Discord privacy settings allow direct messages from server members or you may not receive notifications.

​
Telegram Notifications

​
Finding Your Telegram Username

Your Telegram username is the handle you chose (starting with @):
1

Open Telegram

Open the Telegram app on any device
2

Go to Settings

Tap on the menu icon > Settings
3

View Your Username

Your username is displayed below your name (e.g., @johndoe)
4

Add to PingPilot

Enter your username (with or without the @) in Account Settings

​
Creating a Telegram Username

If you don’t have a username:
1

Open Telegram Settings

Tap on the menu > Settings
2

Edit Profile

Tap on your profile section
3

Set Username

Tap “Username” and create a unique username
Your Telegram username is required to receive event notifications. The API will return a 403 error if your Telegram username is not set.

​
Telegram Message Format

Telegram notifications are sent as formatted text messages: 
🎉 Event Notification 🎉

📌 Category: 🐛 Bug
📝 Description: Critical error in payment processor
🎨 Color Code: 16738667
🕒 Timestamp: 2024-03-06T10:30:00.000Z

📌 Details:
🔹 severity: high
🔹 user_id: 12345
🔹 environment: production

​
Email Notifications

​
Email Configuration

Your email is automatically set based on your account registration:
  • Email used during sign-up is stored in your user profile
  • Notifications are sent to this email address
  • Email cannot be changed independently (tied to your account)

​
Email Format

Emails are sent as HTML with:
  • Subject: “PingPilot Alert”
  • Header: Category title with emoji
  • Body: Event description
  • Details Table: All custom fields in a formatted table
  • Timestamp: When the event occurred
  • Color Accent: Category color used for visual elements
Example email: 
┌─────────────────────────────────────┐
│     PingPilot Alert                 │
├─────────────────────────────────────┤
│                                     │
│  🐛 Bug                             │
│                                     │
│  Critical error in payment          │
│  processor                          │
│                                     │
│  ┌─────────────┬─────────────┐    │
│  │ Field       │ Value        │    │
│  ├─────────────┼─────────────┤    │
│  │ severity    │ high         │    │
│  │ user_id     │ 12345        │    │
│  │ environment │ production   │    │
│  └─────────────┴─────────────┘    │
│                                     │
│  Mar 06, 2024 at 10:30 AM          │
│                                     │
└─────────────────────────────────────┘

​
WhatsApp Notifications

​
WhatsApp Configuration

WhatsApp integration may be limited or in beta. Check the account settings page for availability.
To configure WhatsApp notifications:
1

Go to Account Settings

Navigate to Dashboard > Account Settings
2

Enter Phone Number

Enter your WhatsApp phone number with country code
3

Verify Number

Follow the verification process if required

​
Phone Number Format

Include your country code:
  • ✅ +1234567890 (with country code)
  • ✅ +44 7700 900000
  • ❌ 1234567890 (missing +)

​
Database Storage

Notification preferences are stored in the User model: 
model User {
  id               String  @id @default(cuid())
  email            String  @unique
  discordId        String?  // Required for events
  telegramUsername String?  // Required for events
  whatsappNumber   String?  // Optional
  // ... other fields
}
  • discordId: Stored as string, must be valid Discord user ID
  • telegramUsername: Stored as string, with or without @
  • whatsappNumber: Stored as string, includes country code
  • email: Set during registration, used for all email notifications

​
Notification Delivery

When an event is triggered:
1

Event Received

PingPilot receives your event via the API
2

Validation

System checks that Discord ID and Telegram username are configured
3

Parallel Delivery

Notifications are sent simultaneously to all channels:
  • Discord embed message
  • Telegram text message
  • HTML email
  • WhatsApp message (if configured)
4

Status Tracking

Event status is updated to DELIVERED or FAILED

​
Delivery Status

Each event tracks its delivery status: 
enum DeliveryStatus {
  PENDING    // Event created, delivery in progress
  DELIVERED  // Successfully sent to all channels
  FAILED     // Delivery failed for one or more channels
}
You can view delivery status in your dashboard event history.

​
Required vs Optional Settings

​
Discord ID
string
required
Required - Must be set before sending events. API returns 403 if missing.
​
Telegram Username
string
required
Required - Must be set before sending events. API returns 403 if missing.
​
Email
string
required
Required - Automatically set from your account. Cannot be changed independently.
​
WhatsApp Number
string
Optional - Can be set if you want WhatsApp notifications.

​
Troubleshooting

  • Verify your Discord ID is correct (should be numeric)
  • Check Discord privacy settings allow DMs
  • Ensure you haven’t blocked the PingPilot bot
  • Try sending a test event to verify
  • Confirm your Telegram username is correct
  • Make sure you have a username set (not just a phone number)
  • Check if you’ve blocked the PingPilot bot
  • Verify your username is public in Telegram settings
This means required notification settings are missing:
{
  "message": "Please enter your discord ID in your account settings"
}
Solution: Add your Discord ID and Telegram username in Account Settings.
If an event is marked as FAILED:
  • Check that all notification settings are correct
  • Verify you haven’t blocked the bots on Discord/Telegram
  • Check your email isn’t marking PingPilot as spam
  • Try updating your notification settings and sending another test event
  • Add [email protected] to your contacts
  • Mark PingPilot emails as “Not Spam”
  • Check your email provider’s spam filters

​
Privacy & Security

PingPilot stores:
  • Discord ID (for sending notifications)
  • Telegram username (for sending notifications)
  • WhatsApp number (if provided)
  • Email address (for account and notifications)
This data is used solely for delivering notifications and is never shared with third parties.
The PingPilot Discord bot only has permission to:
  • Create DM channels
  • Send messages to those DM channels
It cannot:
  • Read your messages
  • Access server information
  • See your activity
To stop receiving notifications:
  • Block the Discord bot
  • Block the Telegram bot
  • Delete your PingPilot account
Note: You cannot disable individual notification channels - all configured channels receive events.

​
Testing Your Notification Settings

After configuring your preferences:
  1. Create a test category in your dashboard
  2. Send a test event via the API or dashboard
  3. Verify you receive notifications on all configured channels
  4. Check that the formatting looks correct
# Send a test event
curl -X POST https://pingpilot.com/api/v1/event \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "test",
    "description": "Testing notification settings",
    "fields": {
      "test": "value"
    }
  }'
You should receive notifications within seconds on:
  • Discord (embedded message)
  • Telegram (text message)
  • Email (HTML email)
  • WhatsApp (if configured)

​
Next Steps

Sending Events

Learn how to send events via the API

Creating Categories

Set up event categories for your notifications

Build docs developers (and LLMs) love

Get started for freeTalk to us