cdn.pizzaDokumentation
FRENDE
LoginKonto erstellen

Dienste

Webhooks

Webhooks automatisieren Reaktionen auf unterstützte Kontoereignisse.

#Überblick

Webhooks automatisieren Reaktionen auf unterstützte Kontoereignisse.

#Events sicher empfangen

Ein Webhook verbindet eine HTTPS-URL mit den im Formular oder der API verfügbaren Events. Speichern Sie jedes bei Erstellung zurückgegebene Geheimnis am Empfänger und loggen Sie es nie.

Der Empfänger antwortet schnell, verarbeitet idempotent und verschiebt schwere Arbeit in eine Queue. Prüfen Sie den tatsächlich verfügbaren Signaturmechanismus; ohne Signatur helfen geheime URL und zusätzliche Netzwerkkontrollen.

#Empfänger produktiv setzen

  1. Erstellen Sie einen eigenen HTTPS-Endpoint.

  2. Registrieren Sie Webhook und Geheimnis einmal.

  3. Validieren Sie Event und lehnen Sie ungültige Payloads ab.

  4. Deduplizieren, bestätigen Sie schnell und überwachen Sie Fehler.

#Berechtigungen nach Rolle

Aktionowneradminmemberviewer
Ziele und Ereignisse auflistenLesenLesenLesenLesen
Ziel und dessen Secret erstellenErlaubtErlaubtNeinNein
Ziel löschenErlaubtErlaubtNeinNein

#REST-Operationen für Kunden

Basis-URL: https://api.cdn.pizzaOpenAPI 3.1 herunterladen

Webhooks 3

GET /api/webhooks

#Webhooks auflisten

Authentifizierung
Persönliches Bearer-Token
Rollen
owner, admin, member, viewer
Erfolg
200
Beispiel
bash
curl --request GET \
  --url 'https://api.cdn.pizza/api/webhooks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
POST /api/webhooks

#Webhook erstellen

Authentifizierung
Persönliches Bearer-Token
Rollen
owner, admin
Erfolg
201

Anfragefelder

FeldTypErforderlichBeschreibung
urlstringjaÖffentliche HTTP(S)-Empfänger-URL; HTTPS wird empfohlen.format: uri · length: 0…500
eventsarray<string>jaAbonnierte Ereignisse.items: file.uploaded | file.deleted | domain.created | zone.created | zone.updated | zone.deleted | cache.purged | node.online | node.offline | node.deployed | billing.updated | invoice.paid | mail.accepted | mail.rejected | mail.deferred
secretstringneinVom Kunden gewähltes Signaturgeheimnis.length: 0…255
Beispiel
bash
curl --request POST \
  --url 'https://api.cdn.pizza/api/webhooks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"url":"https://hooks.example.com/cdn-pizza","events":["file.uploaded","file.deleted"]}'
DELETE /api/webhooks/{id}

#Webhook löschen

Authentifizierung
Persönliches Bearer-Token
Rollen
owner, admin
Erfolg
200

Anfragefelder

FeldTypErforderlichBeschreibung
idintegerjaWebhook-ID.
Beispiel
bash
curl --request DELETE \
  --url 'https://api.cdn.pizza/api/webhooks/WEBHOOK_ID' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
KundendokumentationReferenz aus veröffentlichten Schnittstellen generiert