Créer et gérer des Webhooks

Pingen propose des notifications automatiques via des Webhooks pour les événements importants. Par exemple, vous êtes informé en temps réel dès qu'une lettre a été envoyée, qu'elle présente un problème ou qu'elle a été signalée comme non distribuable. Cela vous permet d'exécuter automatiquement d'autres actions sans devoir interroger activement l'API de Pingen pour détecter des changements.

Créer des Webhooks

Les Webhooks peuvent être créés directement dans la application Pingen via l'élément de navigation « Organisation Administration » --> « Webhooks » en cliquant sur le bouton « Ajouter le premier Webhook » :

Ensuite, il faut sélectionner la catégorie d'événement souhaitée pour le Webhook. Pingen propose les catégories d'événements suivantes :

• Problèmes de lettre : Événements qui se rapportent aux problèmes d'envoi d'une lettre. Il s'agit généralement de problèmes liés au traitement de la lettre, par exemple si un PDF n'est pas au format A4, si un PDF contient du contenu dans les zones bloquées, s'il n'y a pas assez de solde disponibles, etc.
• Lettres envoyées : Événements qui se rapportent à la distribution postale, par exemple : si une lettre a été transmise à la poste ou si un numéro de suivi postal a été reçu.
• Lettres non délivrables : Événements qui se rapportent à l'information sur le fait qu'une lettre n'a pas pu être distribuée par la poste et la raison pour laquelle elle ne l'a pas été.
• Lettres livrées : Événements qui se rapportent à l'envoi de lettres avec accusé de réception (comme les lettres recommandées).

Dès qu'une catégorie d'événement a été sélectionnée, l'URL du Webhook (URL à laquelle Pingen doit envoyer les Webhooks) et le Secret de signature doivent être spécifiés. Pour l'URL du Webhook, il est essentiel qu'elle soit accessible sur le port 443. Le Secret est utilisé pour garantir que seules les données provenant de sources fiables sont traitées. Toute chaîne de caractères (32 caractères au maximum) peut être utilisée comme Secret. Si vous spécifiez un Secret, assurez-vous que cette valeur est validée lors du traitement des Webhooks.

Gérer les Webhooks

L'administration des Webhooks peut être ouverte directement dans Pingen via l'élément de navigation « Organisation Administration » --> « Webhooks » en cliquant sur le Webhook concerné :

L'administration des Webhooks fournit un aperçu de toutes les demandes envoyées jusqu'à présent. En outre, dans le coin supérieur droit, vous pouvez également envoyer une requête de test ainsi que renvoyer les requêtes qui ont échoué.

La vue d'ensemble affiche les informations les plus importantes ainsi que l'état de la requête. Les requêtes peuvent avoir les statuts suivants :

• Succès : Le Webhook a été transmis avec succès
• Réessayer : Le Webhook n'a pas encore été transmis avec succès. Cependant, Pingen peut toutefois réessayer la transmission jusqu'à 7 fois
• Échec : Le Webhook n'a pas pu être livré avec succès malgré plusieurs tentatives

En cliquant sur une requête, il est possible d'ouvrir la vue détaillée de la requête en question :

Dans la vue détaillée, vous pouvez voir à la fois le contenu de la requête et la réponse respective de l'URL cible. Les Webhooks dont le statut est « Échec » peuvent également être renvoyés directement via le lien dans la barre latérale.

Supprimer des Webhooks

Les Webhooks peuvent être supprimés directement dans Pingen via l'élément de navigation « Organisation Administration » --> « Webhooks ». Il suffit de passer la souris sur le Webhook souhaité et de cliquer sur l'icône de la poubelle :