Getting Started
This guide will take you from zero to your first notification in less than 5 minutes.
Step 1: Install the App
Section titled “Step 1: Install the App”PushGo is available on all your devices.
- iOS / macOS / watchOS: Search for “PushGo” on the App Store.
- Android: Download from GitHub Releases.
- Windows: Download from GitHub Releases.
Step 2: Set Up a Channel
Section titled “Step 2: Set Up a Channel”In PushGo, a Channel is your private communication pipe.
Option A: Create a New Channel
Section titled “Option A: Create a New Channel”If you want a fresh pipe:
- Open the App and tap the ”+” button.
- Select Create Channel.
- Enter a Channel Name (e.g., “My Home Server”) and a Password (8-128 chars).
- Tap Create. The app will generate a unique Channel ID for you.
Option B: Subscribe to an Existing Channel
Section titled “Option B: Subscribe to an Existing Channel”If you already have a Channel ID (e.g., shared from another device):
- Tap the ”+” button and select Subscribe to Channel.
- Enter the Channel ID and the Password.
- Tap Subscribe.
Step 3: Send Your First Notification
Section titled “Step 3: Send Your First Notification”You can test your channel using a simple POST request.
Public Gateway Testing
Section titled “Public Gateway Testing”Official gateways do not require an API Token by default.
curl -X POST https://gateway.pushgo.dev/message \ -H "Content-Type: application/json" \ -d '{ "channel_id": "YOUR_CHANNEL_ID", "password": "YOUR_CHANNEL_PASSWORD", "title": "Hello from PushGo!", "body": "This is a test notification." }'Success! 🎉
Section titled “Success! 🎉”You should hear a “ding” on your device immediately.
What’s Next?
Section titled “What’s Next?”- Integrating with code? Read the Developer API Guide.
- Using a Private Gateway? Learn about Authentication and Self-Hosting.