Documentation
Documentation
Webhook Listener
Fermer Documentation API
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.

États
  • Créer
    Le statut Create indique que le type Webhook Listener est en cours de création.
  • Actif
    Le statut actif signifie que l’entrée du type «Webhook Listener» est active et qu’elle peut être utilisée.
  • Inactif
    Le statut Inactif montre que l’entrée de type Webhook Listener est inactive et qu’elle n’est peut-être pas utilisée.
  • En cours de suppression
    Le statut deleting indique que l’entrée du type Webhook Listener est en cours de suppression.
  • Supprimé
    Le statut supprimé marque l’entrée pour la suppression de la base de données.
Propriétés
  • Date de suppression prévue
    La date et l'heure auxquelles il est prévu que l'objet soit définitivement supprimé. Si la valeur est vide, l'objet ne sera pas supprimé.
  • Enable Payload Signature And State
    Si l'en-tête de signature et la propriété "state" sont activés dans la charge utile du webhook.
  • Entity States
    Les états cibles de l'entité qui doivent être contrôlés.
  • Entité
    L'entité à surveiller.
  • ID
    A unique identifier for the object.
  • ID du Space référencé
    L'ID de l'espace auquel appartient cet objet.
  • Identité
    L'identité utilisée pour signer les messages.
  • Nom
    Le nom utilisé pour identifier l'auditeur du webhook.
  • Notifier de tous les changements
    Si chaque mise à jour de l'entité ou seulement les changements d'état doivent être surveillés.
  • Statut
    L'état actuel de l'objet.

    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
    URL à laquelle sont envoyées les notifications de changement d'entité.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.