Zum Hauptinhalt springen

Webhooks

Mit Webhooks erhalten Sie Echtzeit-HTTP-Benachrichtigungen, wenn Ereignisse in RxScale auftreten. Anstatt regelmäßig nach Änderungen abzufragen, registrieren Sie eine Webhook-URL, und RxScale sendet Ihnen bei jedem Ereignis eine POST-Anfrage.

Funktionsweise von Webhooks

  1. Registrieren Sie ein Webhook-Abonnement mit Ihrer Ziel-URL und dem gewünschten Ereignistyp.
  2. Empfangen Sie POST-Anfragen an Ihre URL, wenn Ereignisse eintreten.
  3. Überprüfen Sie die Webhook-Signatur, um die Authentizität der Anfrage sicherzustellen.
  4. Antworten Sie mit einem 2xx-Statuscode, um den Empfang zu bestätigen.

Webhook-Payload-Format

Alle Webhook-Payloads folgen derselben Envelope-Struktur:
{
  "event_type": "pharmacy_order_created",
  "timestamp": 1711700000,
  "payload_version": "1",
  "data": {
    // Ereignisspezifische Daten
  }
}
FeldTypBeschreibung
event_typestringDer Typ des aufgetretenen Ereignisses
timestampintegerUnix-Zeitstempel der Ereigniserzeugung
payload_versionstringSchema-Version des Payloads (derzeit "1")
dataobjectEreignisspezifische Daten — siehe Ereignisse für Details

Webhooks registrieren

Sie können Webhooks über folgende Wege registrieren:
  • External Pharmacy APIPOST /v1/external-pharmacy-api-v1/webhooks/
  • Management APIPOST /v1/management/notification-subscriptions/
Jede Registrierung gibt ein signing_secret zurück, das Sie sicher aufbewahren müssen, um Payloads zu verifizieren.

Wiederholungsrichtlinie

Wenn Ihr Endpoint nicht mit einem 2xx-Statuscode antwortet, wiederholt RxScale die Zustellung mit exponentiellem Backoff.