Dokumentation
Dokumentation
Webhook Listener
Schliessen API Dokumentation
Webhook Listener

A webhook can be used to notify another application about events. A webhook listener represents a single listener to such an event.

The notification is carried out by calling the configured 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
    Definiert, ob der Webhook Listener statt nur über Statusänderungen über alle Änderungen informiert werden soll.
  • Entität
    Der Listener hört auf Zustandsänderungen der verknüpften Entität.
  • Entitätsstatus
    Der Zielzustand identifiziert den Zustand, welcher bei einem Zustandsübergang in diesen Zustand den Webhook auslöst.
  • 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 Identität mit welcher die Nachrichten, welche vom Listener gesendet werden, signiert werden.
  • Name
    Der Webhook Listener Name wird intern zur Identifizierung des Webhook Listeners in administrativen Interfaces genutzt. Er wird beispielsweise in Suchfeldern genutzt und sollte daher klar und deskriptiv sein.
  • Referenzierte Space ID
    Die ID des Raums, zu dem dieses Objekt gehört.
  • Status
    Der aktuelle Zustand des Objekts.

    A webhook listener can have the following states:

    Active

    When the state is set to Active the webhook listener is used.

    Inactive

    When the state is set to Inactive the webhook listener is ignored. However, all the information is not deleted and you can reactivate it at any moment.

    Deleting

    The webhook listener is in the process of deletion. This may take some time until the webhook listener is marked as Deleting before being marked as Deleted.

    Deleted

    The webhook listener is deleted. Since the webhook listener is linked with data which cannot be deleted immediately, we need to keep it until all the data can be removed.

  • Url
    Die URL, welche durch den Listener aufgerufen wird um die Applikation über den Event zu informieren.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.