Dokumentation
Dokumentation
Webhook Listener
Schliessen API Dokumentation
Webhook Listener

Ein Webhook kann verwendet werden, um eine andere Anwendung über Ereignisse zu benachrichtigen. Ein Webhook-Listener stellt einen einzelnen Listener für ein solches Ereignis dar.

Die Benachrichtigung erfolgt durch Aufruf der konfigurierten Webhook-URL.

Zustände
  • Erstellen
    Der Status Create zeigt an dass der Typ Webhook Listener gerade erstellt wird.
  • Aktiv
    Der Status aktiv bedeutet, dass der Eintrag vom Typen 'Webhook Listener' aktiv ist und genutzt werden kann.
  • Inaktiv
    Der Status Inaktiv zeigt dass der Eintrag vom Typen Webhook Listener nicht genutzt wird.
  • Im Löschvorgang
    Der deleting Status bedeutet, dass der Eintrag vom Typen Webhook Listener gerade im Prozess der Löschung ist.
  • Gelöscht
    Der Gelöschte-Status markeiert den Eintrag für die Löschung aus der Datenbank.
Eigenschaften
  • Alle Änderungen mitteilen
    Ob jede Aktualisierung der Entität oder nur Zustandsänderungen überwacht werden sollen.
  • Enable Payload Signature And State
    Ob Signatur-Header und 'State'-Eigenschaft in der Webhook-Nutzlast aktiviert sind.
  • Entity States
    Zielzustände des Unternehmens, die überwacht werden sollen.
  • Entität
    Die zu überwachende Einheit.
  • Geplantes Löschdatum
    Das Datum und die Uhrzeit, zu der das Objekt endgültig entfernt werden soll. Wenn der Wert leer ist, wird das Objekt nicht entfernt.
  • ID
    A unique identifier for the object.
  • Identität
    Die zum Signieren von Nachrichten verwendete Identität.
  • Name
    Der Name, der zur Identifizierung des Webhook-Listeners verwendet wird.
  • Referenzierte Space ID
    Die ID des Raums, zu dem dieses Objekt gehört.
  • Status
    Der aktuelle Zustand des Objekts.

    Ein Webhook-Listener kann die folgenden Zustände haben:

    Aktiv

    Wenn der Status auf Active gesetzt ist, wird der Webhook-Listener verwendet.

    Inaktiv

    Wenn der Status auf Inactive gesetzt ist, wird der Webhook-Listener ignoriert. Die Informationen werden jedoch nicht gelöscht, und Sie können ihn jederzeit reaktivieren.

    Wird gelöscht

    Der Webhook-Listener befindet sich im Löschvorgang. Es kann einige Zeit dauern, während der Webhook-Listener als Deleting markiert ist, bevor er als Deleted markiert wird.

    Gelöscht

    Der Webhook-Listener ist gelöscht. Da der Webhook-Listener mit Daten verknüpft ist, die nicht sofort gelöscht werden können, müssen wir ihn behalten, bis alle Daten entfernt werden können.

  • Url
    Die URL, an die Benachrichtigungen über Entitätsänderungen gesendet werden.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.
Staging 2.218.1