Arten von Benachrichtigungen

Zenhook zeichnet jede Art von Ereignis als Widget, gebaut aus seiner eigenen Geschichte. Es gibt nichts zu konfigurieren: Die Daten, die du ohnehin sendest, bestimmen das Widget.

Eine Art von Ereignis ist ein Stream: gleicher Channel und gleicher Titel, Zahlen werden ignoriert. „Bestellung 1284 bezahlt“ und „Bestellung 1285 bezahlt“ sind ein Stream. Halte den Titel stabil und schreibe, was sich ändert, in message, fields oder actor.

Passt ein Stream zu mehreren Typen, gewinnt der erste in dieser Liste.

Pipeline

Wann: Der Titel enthält deploy, build, release, pipeline oder CI, oder das Ereignis trägt einen workflow-Block.
Zeigt: Ob der letzte Lauf bestanden hat oder fehlgeschlagen ist, die letzten Läufe als Streifen und wie viele bestanden haben.

Senden

json

{
  "title": "api deploy",
  "level": "success",
  "message": "v2.4.0"
}

Fehler

Wann: level ist error und es ist heute oder diese Woche mindestens zweimal passiert. Ein einzelner Fehler bleibt eine offene Karte.
Zeigt: Das wievielte Vorkommen heute, seit wann, die betroffenen Stunden, die Nachricht und dein Link.

Senden

json

{
  "title": "Zahlungs-Webhook fehlgeschlagen",
  "level": "error",
  "message": "Stripe-Signatur stimmt nicht überein",
  "linkUrl": "https://…"
}

Geld

Wann: Ein Feld namens Betrag, Preis, Summe, Gesamt, Umsatz, Bezahlt, Zahlung, Amount, Price, Total, Revenue, Paid, Payment oder MRR enthält einen Betrag.
Zeigt: Die Tagessumme im Währungsformat des Lesers, die Anzahl der Zahlungen und die Woche.

Senden

json

{
  "title": "Zahlung erhalten",
  "level": "success",
  "fields": [
    {
      "label": "Betrag",
      "value": "49,00 €"
    }
  ]
}

Person

Wann: Das Ereignis hat einen actor (oder user).
Zeigt: Wer, mit Foto oder Initialen, Firma und Tarif, und wie viele heute und diese Woche.

Senden

json

{
  "title": "Neue Registrierung",
  "actor": {
    "name": "Jane Cooper",
    "email": "[email protected]"
  }
}

Serie

Wann: Es passiert etwa einmal am Tag, höchstens dreimal, an drei oder mehr Tagen in Folge.
Zeigt: Wie viele Tage in Folge, und die Woche als Häkchen.

Senden

json

{
  "title": "Nächtliches Backup",
  "level": "success"
}

Zähler

Wann: Der Standard für alles, was sich wiederholt: zweimal heute oder dreimal diese Woche.
Zeigt: Die Zahl des Tages, die Veränderung gegenüber gestern zur gleichen Stunde, Balken pro Stunde und die Spitze.

Senden

json

{
  "title": "Bericht exportiert",
  "message": "Umsatz Q3, CSV"
}

Offene Karte

Wann: Ein einmaliges Ereignis, oder das erste seiner Art.
Zeigt: Alles, ohne Klick: Nachricht, Felder und Link.

Senden

json

{
  "title": "Domain verlängert",
  "message": "Automatisch um ein Jahr verlängert.",
  "fields": [
    {
      "label": "Domain",
      "value": "acme.com"
    }
  ]
}

Jedes Feld ist in der Webhook-API-Referenz beschrieben.