Hilfe

Alles, was du über PushPig wissen musst.

💡 Was ist PushPig?

PushPig ist ein Push-Benachrichtigungsdienst: Du erstellst Kanäle, andere Nutzer abonnieren sie — und wenn du eine Nachricht sendest, landen sie in Echtzeit auf allen Geräten der Abonnenten: Android, Browser und per E-Mail.

Typische Anwendungsfälle:

• Server- und Monitoring-Alarme aus eigenen Skripten
• Deploy-Benachrichtigungen aus CI/CD-Pipelines
• Infos für eine Gruppe (Familie, Team, Verein)
• Eigene Smart-Home-Ereignisse weiterleiten

⚡ Schnellstart

1. Kanal erstellen

Nach dem Login auf „+ Kanal" klicken, Namen und optionale Beschreibung eingeben. Öffentliche Kanäle sind für alle sichtbar und beitretbar; private Kanäle nur per Einladung.

2. API-Key abrufen

Im Dashboard unter Einstellungen → API-Schlüssel einen neuen Key generieren. Dieser Key authentifiziert deine Anwendung beim Senden über die REST-API.

3. Erste Nachricht senden

curl -X POST https://pushpig.de/api/push/send \
  -H "X-API-Key: DEIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "mein-kanal",
    "body":    "Hallo von der API!"
  }'

4. Abonnieren & Benachrichtigungen empfangen

• Android-App: Kanal öffnen → Abonnieren → Push-Benachrichtigungen aktivieren
• Browser: Im Dashboard auf den Kanal klicken → Glocken-Symbol → Browserbenachrichtigungen erlauben
• E-Mail: Im Kanal das E-Mail-Symbol aktivieren (setzt verifizierte E-Mail-Adresse voraus)

📄 API-Referenz

Authentifizierung

Jeder API-Request benötigt einen gültigen API-Key im Header:

X-API-Key: DEIN_API_KEY

Nachricht senden

POST https://pushpig.de/api/push/send

* channel oder channel_id ist erforderlich.

Beispiel mit allen Feldern

curl -X POST https://pushpig.de/api/push/send \
  -H "X-API-Key: DEIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "deploy-alerts",
    "title":   "Deploy erfolgreich",
    "body":    "Version 2.4.1 ist live.",
    "actions": [
      { "title": "Changelog", "url": "https://example.com/changelog" }
    ],
    "payload": { "version": "2.4.1", "env": "production" }
  }'

Antwort

{
  "success":      true,
  "event_id":     42,
  "fcm_sent":     3,
  "webpush_sent": 1,
  "email_sent":   2
}

Rate Limit

Maximal 60 Nachrichten pro Minute pro Account. Bei Überschreitung: HTTP 429.

❓ Häufige Fragen