Schlüssel/Wert-Speicher-API

Gibt höchstens 200 Einträge in aufsteigender Schlüsselreihenfolge zurück. next_cursor ist der zuletzt zurückgegebene Schlüssel; geben Sie ihn als after zurück, um die nächste Seite abzurufen. next_cursor ist null, wenn keine weiteren Einträge vorhanden sind. Eine Dashboard-Sitzung liest hier die Einträge ihres Projekts für die Vorschau der Web-App; das Dashboard besitzt keinen KV-Schreibzugriff.

Eingehende Key/Value-Webhooks der Anwendung auflisten, älteste zuerst (maximal 20), jeweils mit dem Schlüssel, den sie schreiben, ihrer Ingest-URL und last_used_at, sobald sie geschrieben haben. Das Geheimnis wird hier niemals zurückgegeben.

Erstellt einen eingehenden Schlüssel/Wert-Webhook: eine URL, die einen Schlüssel dieser Anwendung schreibt, sodass ein externes System (Zapier, Make, eine Kasse, ein Cron-Job, curl) Daten mit einem HTTP POST an Bildschirme sendet; siehe POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write. Der Schlüssel muss noch nicht existieren.

Die Antwort ist der einzige Ort, an dem das Geheimnis erscheint (mit der Rotationsantwort): Speichern Sie es sofort im sendenden System; der Server behält eine Prüfsumme. Eine Anwendung hat höchstens 20 Webhooks (kv_webhook_limit_reached). Fügt kv_webhook.created hinzu. Ein exakter Wiederholungsversuch mit demselben Idempotency-Key liefert diese gleiche Antwort, einschließlich Geheimnis, für vierundzwanzig Stunden.

Löscht den Webhook. Seine URL funktioniert sofort nicht mehr; der von ihm geschriebene Schlüssel behält seinen Wert. Fügt kv_webhook.deleted hinzu.

Ersetzt das Geheimnis des Webhooks und gibt das neue einmal zurück. Das alte Geheimnis funktioniert sofort nicht mehr; aktualisieren Sie das sendende System. Fügt kv_webhook.secret_rotated hinzu. Ein exakter Wiederholungsversuch mit demselben Idempotency-Key gibt diese Antwort einschließlich Geheimnis für 24 Stunden zurück.

Die URL, an die ein externes System den neuen Wert eines Schlüssels sendet. Authentifiziert sich nur mit dem eigenen Geheimnis des Webhooks im Authorization-Header: Bearer <secret> oder HTTP Basic mit der Webhook-ID als Benutzername und dem Geheimnis als Passwort. Ein Geheimnis in der URL oder Abfrage wird niemals akzeptiert.

Ein unbekannter Webhook, einer einer anderen Anwendung und ein falsches Geheimnis antworten alle mit derselben 401. Der Rohkörper, maximal 1 MiB, wird zum Wert des Webhook-Schlüssels, und der Content-Type-Header wird dessen content_type (application/octet-stream, wenn nicht vorhanden; ein Header, der kein Medientyp ist, ist invalid_request).

Der Schreibvorgang ist PUT /api/applications/{application_id}/kv/{key} ohne If-Match: er ersetzt den Wert, erhöht die Revision, wird gemessen und gegen das Kontingent geprüft wie jeder K/V-Schreibvorgang, ist eine abgerechnete API-Anfrage, die nie wegen des Guthabens abgelehnt wird, und hängt kv.updated an.

Idempotency-Key (8 bis 200 Zeichen) dedupliziert Wiederholungen eines Senders für einen Schreibvorgang über vierundzwanzig Stunden. Derselbe Schlüssel mit anderem Body oder Content-Type ist idempotency_mismatch; ohne ihn ist jeder Post ein neuer Schreibvorgang. Die Antwort sind die neuen Metadaten des Schlüssels, nie dessen Wert.

Höchstens 120 Schreibvorgänge pro Minute und Webhook; jeder zählt außerdem zu den Schreibraten der Organisation und des Schlüssels (PUT /api/card-data/{key}).