Referenz

POST /v1/push

Eine Nachricht schicken: alle Felder, Antwort und Fehler.

Als Markdown öffnen

Schickt eine Nachricht in den Kanal des Packlets. Geht für jede Kanal-Art: Im Kanal ist es eine Meldung oder die Antwort deines Tools, bei einer App eine Mitteilung unter der Glocke. Statt des Schlüssels des Packlets geht auch der Schlüssel eines Dienstes.

Die Anleitung dazu: Nachricht senden.

Aufruf

HTTP
POST https://api.packlets.app/v1/push
Authorization: Bearer <PACKLETS_KEY>
Content-Type: application/json

Felder

FeldTypPflichtBedeutung
textText, 1 bis 10.000 ZeichenjaDie Nachricht. Erlaubt ist einfache Formatierung.
titleText, bis 80 ZeichenneinÜberschrift.
urlhttps-Adresse, bis 2.048 ZeichenneinLink der Nachricht.
imagehttps-Adresse, bis 2.048 ZeichenneinBild über dem Text.
buttonsListe, bis 3 EinträgeneinKnöpfe unter der Nachricht.
elementsListe, bis 12 EinträgeneinElemente in der Nachricht.
prioritynormal, high oder silentneinStandard normal. Siehe Push, Ton und Ruhezeit.

Felder eines Knopfs

FeldTypPflichtBedeutung
idText, 1 bis 64 ZeichenjaDeine Kennung, pro Nachricht eindeutig. Kommt im Webhook als button_id zurück.
labelText, 1 bis 40 ZeichenjaBeschriftung.
urlhttps-AdresseneinMit url öffnet der Knopf einen Link, ohne meldet er den Tipp an deinen Webhook.

Beispiel

JSON
{
  "title": "Deploy fehlgeschlagen",
  "text": "**shop-api** auf main: Tests rot in `checkout.test.ts`.",
  "url": "https://ci.example.com/runs/4711",
  "priority": "high",
  "buttons": [
    { "id": "retry", "label": "Erneut starten" },
    { "id": "log", "label": "Log öffnen", "url": "https://ci.example.com/runs/4711/log" }
  ]
}

Antwort

JSON
{ "message_id": "5b0c1a52-7c1e-4a43-9d0b-2f6f0c7d1e11" }
FeldBedeutung
message_idKennung der Nachricht. Sie kommt in Webhook-Ereignissen zu dieser Nachricht wieder.
warningsNur wenn Packlets die Größe eines Elements angepasst hat: Liste mit je einem Satz pro Änderung.

Status 200 heißt: Die Nachricht ist gespeichert und steht im Kanal. Das gilt auch, wenn der Push nicht zugestellt wird, zum Beispiel in der Ruhezeit.

Der erste erfolgreiche Aufruf verbindet das Packlet: Die App zeigt „Verbunden!“.

Fehler

StatuserrorWann
400invalid_bodyEin Feld fehlt oder passt nicht. details nennt Feld und Grund.
401missing_key, invalid_keySchlüssel fehlt oder ist falsch.
429rate_limitedMehr als 60 Aufrufe in einer Minute für das Packlet, oder mehr als 300 für das Konto.

Was du jeweils tun kannst, steht unter Fehlercodes.