Skip to main content
Get up and running with PingPilot and receive your first event notification in minutes.
Before you begin, make sure you have an email address ready for account creation.

​
Create Your Account

1

Sign Up

Navigate to the PingPilot signup page and create your account using your email address or social login.After signing up, you’ll be redirected to a welcome page while your account is being configured.
2

Access Your Dashboard

Once setup is complete, you’ll automatically be redirected to your dashboard. This is your central hub for managing event categories and monitoring notifications.Your account starts on the Free plan with:
  • 100 events per month
  • Up to 3 event categories
3

Configure Notification Channels

To receive notifications, you need to connect at least one notification channel. Navigate to Account Settings and configure:
  1. Get your Discord User ID:
    • Open Discord and enable Developer Mode (User Settings → Advanced → Developer Mode)
    • Right-click your username and select “Copy User ID”
  2. Paste your Discord ID in the Account Settings
  3. Save your settings
You must configure at least Discord or Telegram to receive event notifications. Email alone is not sufficient for real-time alerts.
4

Create Your First Category

Event categories help you organize different types of notifications.
  1. On your dashboard, click the “Add Category” button
  2. Enter a category name (e.g., “user-signup”, “sales”, “errors”)
  3. Choose a color to visually distinguish this category
  4. Optionally, select an emoji icon
  5. Click “Create Category”
Use descriptive category names that match your use case. For example: payment-received, new-user, system-error.
5

Get Your API Key

You’ll need an API key to send events to PingPilot.
  1. Navigate to API Key in the settings menu
  2. Copy your unique API key
  3. Keep this key secure - it’s like a password for your account
Never commit your API key to version control or share it publicly. If compromised, regenerate it immediately from the API Key settings.
6

Send Your First Event

Now you’re ready to trigger your first notification! Use this example to 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": "user-signup",
    "description": "A new user just joined!",
    "fields": {
      "username": "johndoe",
      "email": "[email protected]",
      "plan": "free"
    }
  }'
Replace YOUR_API_KEY with the API key you copied earlier, and make sure the category matches the one you created.
7

Check Your Notifications

Within seconds, you should receive notifications on all configured channels:
  • Discord: A rich embed message in your DMs
  • Telegram: A formatted text message from the PingPilot bot
  • Email: A styled email notification
The notification will include:
  • The category name and emoji
  • Your custom description
  • All the fields you included (username, email, plan)
  • A timestamp
Not receiving notifications? Check that your Discord ID or Telegram username is correctly configured in Account Settings.

​
What’s Next?

API Reference

Explore the complete API documentation and advanced features

Upgrade Your Plan

Need more events or categories? Check out Pro and Enterprise plans

Event Categories

Learn how to organize and manage your event categories

Notification Channels

Configure additional notification channels and webhooks

​
Common Issues

This means your API key is invalid or missing. Make sure you:
  • Include the Authorization header in your request
  • Use the format: Bearer YOUR_API_KEY
  • Copy the complete API key from your dashboard without any extra spaces
The category name in your API request must exactly match a category you’ve created in your dashboard. Category names are case-sensitive.
This usually means you haven’t configured your Discord ID or Telegram username in Account Settings. Both are required to receive notifications.
Free accounts are limited to 100 events per month. You can:
  • Wait until next month when your quota resets
  • Upgrade to Pro (1,000 events/month) or Enterprise (10,000 events/month)
  • Check your current usage in the Dashboard

Build docs developers (and LLMs) love

Get started for freeTalk to us