Webhooks-API

Listet die Webhook-Benachrichtigungen des Projekts in der Webhook-Form auf, älteste zuerst (höchstens 50); GET /api/notifications listet jeden Kanal auf. Das Signing-Secret wird hier nie zurückgegeben. Erfordert die Projekt-Berechtigung; ein Token nur für Berichte wird mit 403 forbidden abgelehnt, weil die Antwort Empfänger-URLs enthält.

Erstellt einen Webhook, der die dauerhaften Ereignisse des Projekts als signierte HTTPS-POSTs empfängt. Die URL muss https auf einem öffentlichen Internet-Host sein: eine IP-Literal oder jede aktuelle DNS-Antwort des Namens muss öffentlich sein (private, loopback, link-local, CGNAT, IPv6 außerhalb 2000::/3, Dokumentation und andere reservierte Bereiche werden mit webhook_url_rejected abgelehnt).

Der Port muss 443 (Standard) oder 8443 sein, sonst webhook_url_rejected. Der Host wird vor jeder Zustellung aufgelöst und erneut geprüft, und die Verbindung wird genau zur geprüften Adresse aufgebaut, sodass eine spätere DNS-Änderung keine Zustellungen umleiten kann. event_types listet genaue Ereignistypen (screen.online) oder Präfixe mit Endung .* (screen.*).

Eine Organisation hat höchstens 50 Benachrichtigungen über alle Kanäle (webhook_limit_reached). Der Server erzeugt das Signing-Secret und gibt es nur in dieser Antwort und in rotate-secret zurück; speichern Sie es. Eine exakte Wiederholung mit demselben Idempotency-Key liefert vierundzwanzig Stunden lang dieselbe Antwort, Secret eingeschlossen.

Die Zustellung beginnt mit dem ersten Ereignis nach notification.created.

Erfordert die Projektberechtigung; eine nur für Berichte gültige Anmeldeinformation wird mit 403 forbidden abgelehnt, da die Antwort Empfänger-URLs enthält.

Ändert eines der Felder url, event_types, enabled und description (eine leere Beschreibung löscht sie). Eine neue URL wird wie bei der Erstellung geprüft.

Das Aktivieren eines deaktivierten Webhooks löscht dessen Fehlerstatus und startet die Zustellung beim Ereignis, das die Änderung aufzeichnet; Ereignisse während der Deaktivierung werden nicht erneut abgespielt, und noch ausstehende Zustellungen vor der Deaktivierung werden mit webhook_disabled als fehlgeschlagen markiert. Das Deaktivieren schlägt ausstehende Zustellungen mit webhook_disabled fehl.

Hängt notification.updated an. If-Match schützt die Revision.

Löscht den Webhook und hängt notification.deleted an. Seine ausstehenden Zustellungen werden mit webhook_deleted als fehlgeschlagen markiert; sein Zustellungsprotokoll ist nicht mehr adressierbar und läuft mit der Ereignisaufbewahrung ab.

Ersetzt das Signing-Secret und gibt das neue zurück; das alte Secret signiert sofort nicht mehr: Jeder Versuch, der nach dem Festschreiben dieser Änderung signiert, verwendet das neue Secret, und höchstens ein bereits laufender Versuch pro Webhook kann noch mit dem alten signiert eintreffen, akzeptieren Sie daher kurzzeitig beide. Hängt notification.updated mit details.changed [secret] an.

Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt dasselbe neue Geheimnis für vierundzwanzig Stunden zurück.

Hängt ein Projektereignis notification.test an und stellt eine Zustellung davon nur an diesen Webhook in die Warteschlange (kein anderer Webhook erhält notification.test). Der Aufruf funktioniert bei einem deaktivierten Webhook, wird einmal ohne Wiederholungen versucht, wird wie jede Zustellung abgerechnet und ändert nie den Fehlerzustand des Webhooks. Fragen Sie das Zustellungsprotokoll nach dem Ergebnis ab.

Das Zustellprotokoll des Webhooks, neuestes Ereignis zuerst. Eine Zeile pro (Webhook, Ereignis); Wiederholungen aktualisieren die Zeile und GET .../deliveries/{delivery_id}/attempts listet die neuesten Versuche auf. Zeilen werden wie Ereignisse aufbewahrt (die Ereignisaufbewahrung des Plans, mindestens das 24-Stunden-Wiederholungsfenster). Übergeben Sie next_cursor für die nächste Seite als Parameter before.

Versuche einer Lieferung, neueste zuerst, die letzten 20, gespeichert mit der Lieferzeile und so lange. Jeder hat seine Versuchnummer, wann er beendet wurde, den HTTP-Status des Empfängers (null, wenn keiner antwortete), die Fehlerklasse (null bei Erfolg) und seine Dauer. Antwortkörper und Header werden nie gespeichert. Eine Lieferung, die vor der Speicherung von Versuchen aufgezeichnet wurde, listet keine auf.

Eine Lieferung, die nicht zu diesem Webhook oder einem Webhook eines anderen Projekts gehört, ist not_found.