Webhook-Ereignisse und Payloads

Hostware sendet jedes Mal einen JSON-Payload an deinen konfigurierten Endpunkt, wenn eines der abonnierten Geschäftsereignisse eintritt. Diese Referenz führt die Event-Keys auf, die du abonnieren kannst, den Envelope jeder Anfrage sowie die Erfassung und Wiederholung von Zustellungen.

JSON-Envelope

Jede Webhook-Anfrage enthält einen JSON-Envelope mit dem Event-Key, dem Zeitpunkt des Ereignisses und den ereignisspezifischen Daten dieses Ereignisses.

Ereignisse

Jede Zustellung enthält den Key des Ereignisses, das sie ausgelöst hat, sowie den Payload dieses Ereignisses. Die Ereignisse sind unten nach Geschäftsbereich gruppiert.

Abrechnung

Ereignis	Bei Auslösung	Inhalt des Payloads
`invoice.created`	Eine Rechnung wurde erstellt.	IDs und Abrechnungsfelder der Rechnung.
`invoice.paid`	Eine Rechnung wurde bezahlt.	IDs und Abrechnungsfelder der Rechnung.
`payment.failed`	Eine Zahlung ist fehlgeschlagen.	IDs und Felder der fehlgeschlagenen Zahlung.
`order.placed`	Eine Bestellung wurde aufgegeben.	IDs und Felder der Bestellung.

Domains

Ereignis	Bei Auslösung	Inhalt des Payloads
`domain.registered`	Eine Domain wurde registriert.	IDs und Felder der registrierten Domain.
`domain.transfer_completed`	Ein Domaintransfer wurde abgeschlossen.	IDs und Felder der übertragenen Domain.

Dienste

Ereignis	Bei Auslösung	Inhalt des Payloads
`service.activated`	Ein Dienst wurde aktiviert.	IDs und Felder des Dienstes.
`service.renewed`	Ein Dienst wurde verlängert.	IDs und Felder des Dienstes.
`service.suspended`	Ein Dienst wurde gesperrt.	IDs und Felder des Dienstes.
`service.unsuspended`	Die Sperrung eines Dienstes wurde aufgehoben.	IDs und Felder des Dienstes.
`service.terminated`	Ein Dienst wurde beendet.	IDs und Felder des Dienstes.

Kunden

Ereignis	Bei Auslösung	Inhalt des Payloads
`customer.passkey_added`	Ein Passkey wurde zu einem Kundenkonto hinzugefügt.	IDs des Kunden; keine Credential-IDs, öffentlichen Schlüssel oder Credential-Hashes.
`customer.settings_saved`	Die Kundeneinstellungen wurden gespeichert.	IDs und Einstellungsfelder des Kunden.

Support

Ereignis	Bei Auslösung	Inhalt des Payloads
`ticket.created`	Ein Support-Ticket wurde erstellt.	IDs und Felder des Tickets.

Zustellung und Wiederholungen

Zustellungen werden in eine Warteschlange gestellt und wiederholt, sodass ein vorübergehender Fehler auf deiner Seite nicht zum Verlust des Ereignisses führt. Hostware wiederholt eine fehlgeschlagene Zustellung bis zu dreimal, mit ungefähr einer Minute Abstand und anschließend fünf Minuten Abstand zwischen den Versuchen. Für jede Zustellung werden der von deinem Endpunkt zurückgegebene Antwortstatus und -body, der Erfolg der Zustellung, etwaige Fehler und die Zustellungsdauer erfasst. Zustellungsdatensätze, die älter als 90 Tage sind, werden durch eine geplante Bereinigung entfernt.

Geltungsbereich des Vertriebskanals

Nur aktive Abonnements für den relevanten Vertriebskanal erhalten passende Ereignisse; ein Webhook-Datensatz ohne Vertriebskanal wird nicht als globales Abonnement behandelt. Wenn eine erwartete Zustellung nie eintrifft, überprüfe, ob der Webhook aktiv und dem Vertriebskanal zugewiesen ist, zu dem das Ereignis gehört.

Sicherheit

Payloads können Kunden- und Abrechnungsdaten enthalten. Behandle daher jeden von dir registrierten Endpunkt als vertraulich. Der Payload für das Hinzufügen eines Passkeys enthält keine Credential-IDs, öffentlichen Schlüssel oder Credential-Hashes; diese Werte sind niemals in einer Zustellung enthalten.

Siehe Ausgehende Webhooks einrichten für die Konfigurationsschritte.

War das hilfreich?