Documentation

Learn how to integrate PingFlow into your SaaS application and start receiving real-time notifications.

Getting Started

PingFlow is a powerful notification service that sends real-time alerts about events in your SaaS application to Discord, WhatsApp, and Telegram.

Quick Setup

Sign up for a PingFlow account
Create a project and get your API key
Configure your notification channels (Discord, WhatsApp, or Telegram)
Start sending events via our simple API

API Integration

Send events to PingFlow using a simple HTTP POST request. Here's a basic example:

curl -X POST https://api.pingflow.com/v1/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "user.signup",
    "title": "New User Signup",
    "message": "John Doe just signed up!",
    "data": {
      "email": "john@example.com",
      "plan": "premium"
    }
  }'

Event Types

PingFlow supports various event types including:

Sales Events: Track purchases, subscriptions, and revenue
User Events: Monitor signups, logins, and user activity
Error Events: Get notified about application errors and issues
Custom Events: Create your own event types for any use case

Channel Configuration

Discord

Connect your Discord webhook URL to receive notifications in your Discord server channels.

Configure WhatsApp Business API integration to send notifications directly to WhatsApp.

Set up a Telegram bot to receive notifications in your Telegram chats or groups.

Best Practices

Use meaningful event names that clearly describe what happened
Include relevant data in the event payload for better context
Set up rate limiting to avoid overwhelming your notification channels
Test your integration in a development environment first
Monitor your event usage to stay within your plan limits

Need Help?

If you need assistance with integration or have questions, please don't hesitate to contact our support team.

Contact Support