Webhooks et journal de livraison

À quoi cela sert

Un webhook signale à un autre système des événements d’EasyUC. Dès qu’un utilisateur final, un téléphone, un device profile, une boîte vocale ou une tâche Enduser est créé, modifié ou supprimé, EasyUC envoie à l’adresse enregistrée une requête POST contenant les détails.

Les destinataires typiques sont des systèmes de tickets et des systèmes d’inventaire ou de facturation. EasyUC consigne chaque livraison avec la requête, la réponse et le code de réponse. Si une livraison échoue, EasyUC réessaie, jusqu’à huit fois au total.

Prérequis

Un compte ayant le type d’accès Administrator (full access) (ROLE_APP_ADMIN) ou le compte propriétaire (ROLE_OWNER). Seuls ces comptes voient le menu Administration.
Une adresse du destinataire qui accepte les requêtes POST et qui est joignable depuis le serveur EasyUC.
Pour HTTPS, un certificat du destinataire auquel le serveur EasyUC fait confiance.
Si le destinataire exige une authentification : nom d’utilisateur et mot de passe pour Basic Auth.
Pour les e-mails d’erreur : un envoi d’e-mails configuré.

Procédure pas à pas : créer un webhook

Ouvrez l’espace de travail EasyUC Cisco.
Sélectionnez Administration → Integrations & Communication → Webhooks.
Cliquez sur Add Webhook en haut à droite.
Sous Payload URL, saisissez l’adresse du destinataire, par exemple https://tickets.intern/hooks/easyuc.
Sous SSL verification, laissez la sélection Enable SSL verification telle quelle.
Si le destinataire exige une authentification, activez Credentials (Basic Auth) et renseignez Username, Password et Retype Password.
Sous Add email addresses (type an e-mail address and press enter), saisissez les adresses qui doivent recevoir un e-mail en cas d’erreur de livraison.
Sous Which events (actions) would you like to trigger this webhook?, sélectionnez soit Send me everything, soit Let me select individual actions, puis cochez Create, Update et Delete pour chaque objet.
Sous To which CUCM connections would you like to apply this webhook?, sélectionnez soit All, soit Select connections, puis les clusters sous Connections.
Cliquez sur Create. Le webhook apparaît dans la liste avec le badge enabled et la mention This hook has never been triggered.

Procédure pas à pas : vérifier la livraison

Déclenchez un événement correspondant, par exemple en modifiant un utilisateur de test.
Dans la ligne du webhook, cliquez sur Actions → Audit Logs.
Lisez la colonne Event Status : pending, processing, success ou error, avec le response code du destinataire.
Dans la ligne, cliquez sur View → Request sent pour voir les données transmises.
Cliquez sur View → Response received pour voir la réponse du destinataire.

Procédure pas à pas : modifier, désactiver ou supprimer un webhook

Dans la ligne, cliquez sur Actions → Update. La fenêtre Update Webhook s’ouvre.
Pour le désactiver temporairement, désactivez Enable. Les autres champs disparaissent et les réglages restent enregistrés.
Si nécessaire, modifiez l’adresse, les événements ou les connexions, puis cliquez sur Update.
Pour le supprimer, sélectionnez Actions → Delete et confirmez la demande Are you sure?.

Champs et options

Champs et options
Champ / action	Signification et utilisation
Enable	Uniquement lors de la modification. Désactivé : le webhook n’envoie rien. Les nouveaux webhooks sont activés.
Payload URL	Adresse à laquelle EasyUC envoie la requête POST.
SSL verification	Enable SSL verification (par défaut) vérifie le certificat du destinataire. Disable (not recommended) désactive la vérification.
Credentials (Basic Auth)	Commutateur Enabled ou Disabled. Activé : EasyUC s’authentifie auprès du destinataire avec Username et Password. Par défaut : désactivé.
Add email addresses	Destinataires d’un e-mail en cas d’erreurs de livraison. Plusieurs adresses sont possibles ; validez chacune avec Entrée.
Send me everything / Let me select individual actions	Par défaut : Send me everything. Avec la sélection individuelle, les groupes d’objets apparaissent.
Enduser	Create, Update, Delete et Auto Delete (compact info) pour les utilisateurs supprimés par le nettoyage automatique.
Voicemails	Create, Update, Delete pour les boîtes vocales.
Phones	Create, Update, Delete pour les périphériques.
Device Profiles	Create, Update, Delete pour les device profiles.
Enduser Tasks	Create et Delete. En plus, le choix Send full task info (par défaut) ou Send compact task info.
All / Select connections	Par défaut : All clusters. Avec une sélection, uniquement les événements des connexions sélectionnées.
Redelivery (journal de livraison)	Affiche true si l’entrée est une nouvelle tentative de livraison, sinon false.
Created At / Delivered At	Heure de l’événement et de la livraison réussie. En dessous, le cas échéant, sent after <number> attempts ou not delivered after 8 attempts.

Vérifier le résultat et circonscrire les erreurs

Réussite : le journal de livraison affiche success avec le code de réponse du destinataire et une heure sous Delivered At.
Statut error avec un code de réponse supérieur ou égal à 400 : le destinataire a refusé la requête. Vérifiez l’adresse, les identifiants et la réponse sous Response received.
Statut error sans code de réponse exploitable : EasyUC ne peut pas joindre le destinataire ou ne fait pas confiance au certificat. Vérifiez la résolution de noms, le pare-feu et la chaîne de certificats. Ne désactivez pas la vérification SSL de façon permanente.
Statut pending (after <number> attempts) : EasyUC réessaie la livraison. Après huit tentatives, not delivered after 8 attempts s’affiche.
Le destinataire doit être capable de traiter plusieurs fois le même événement.
Aucune entrée n’est créée : l’événement ne correspond pas à la sélection d’actions ou de connexions, ou le webhook est désactivé.