Notifications Webhook

La page Notifications Webhook vous permet de vous abonner à des endpoints d'API pour écouter des événements spécifiques et recevoir des notifications à leur sujet.

2844

La page est organisée selon les groupes suivants :

  • Document
  • Classification
  • Média
  • Variant
  • Liaisons
  • Valeur

Quable PIM Événements

Pour chaque groupe, les événements suivants sont disponibles :

EntitéType d'événementDéclencheurs
Classificationsclassification.create
classification.update
classification.delete
Documentsdocument.create
document.update
document.delete
  • link.delete sur chaque liaison déclarée sur l'élément supprimé

  • document.update sur chaque document précédemment lié à l'élément précédent
Liaisonslink.create
  • document.update sur chaque document lié, le cas échéant.

  • media.update sur chaque document lié, le cas échéant.
link.update
  • document.update sur chaque document lié, le cas échéant.

  • media.update sur chaque document lié, le cas échéant.
link.delete
  • document.update sur chaque document lié, le cas échéant.

  • media.update sur chaque document lié, le cas échéant.
Médiamedia.create
media.update
  • document.update sur chaque document lié
media.delete
  • document.update sur chaque document précédemment lié
Valeurs prédéfiniesvalue.create
value.update
  • document.update sur chaque document utilisant cette valeur
value.delete
  • document.update sur chaque document utilisant précédemment cette valeur
Variantsvariant.create
variant.update
  • document.update sur le document parent, le cas échéant.
variant.delete
  • document.update sur le document parent, le cas échéant.

S'abonner à des événements

Pour lancer la réception de notifications par webhook, vous devez vous abonner aux événements d'un groupe .

2184

Sur la droite, cliquez sur le slide d'un événement pour changer son statut en Actif.

👍

Par défaut, tous les événements sont Inactif

Puis, dans la zone de texte située à gauche, saisissez l'URL du endpoint approprié pour recevoir la ou les notifications. Note : L'URL saisie doit être un endpoint HTTPS.

Enfin, dans la zone de texte En-tête d'autorisation, saisissez les informations nécessaires (généralement un jeton de porteur) pour accéder au endpoint spécifié pour l'événement. Remarque : Cette étape n'est pas obligatoire.

Une fois que vous avez saisi toutes les informations relatives à l'abonnement ou aux abonnements, cliquez sur le bouton Sauvegarder pour enregistrer vos modifications.

Désactiver les notifications

A tout moment, vous pouvez désactiver une notification par webhook en cliquant sur le slide switch d'un événement pour changer son statut en Inactif.

142

Désactivation automatique

Multiples tentatives et gestion d'erreur

Chaque notification peut-être relancé jusqu'a 3 fois par notre service.
Au bout de 3 tentatives infructueuses, la notification est considérée en erreur.
Les causes de notification infructueuse sont multiples :

  • Notre service ne reçoit pas de réponse positive (Une réponse HTTP en 2xx)
  • Notre service ne reçoit pas de réponse dans les 5 secondes

Désactivation

La règle de désactivation se base sur un comptage du nombre d'erreur, de la façon suvante :

Sur les 7 derniers jours, pour 1 profil de notification webhook, si nous rencontrons plus de 50 erreurs et que le nombre d'erreur est supérieur au nombre de succès, alors la configuration est désactivée.

Ainsi, si hier, 50000 notifications ont été faites avec succès, mais que ce jour, 100 notifications ont été considérées en erreur, la configuration du webhook ne sera pas désactivée.

Lors de la désactivation, un email est envoyé aux administrateurs.