Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Webhooks

    Translatable
    Pour configurer un profil de définition webhooks, vous devez avoir le rôle suivant :
    • Administrateur général du système
    Les webhooks sont des rappels HTTP définis par l'utilisateur qui sont généralement déclenchés par un événement, et qui incluent des informations sur les résultats ou le statut de cet événement.
    Alma peut envoyer un webhook lorsque l'un des événements suivants se produit:
    • Un traitement (utilisant l'interface d'utilisateur Alma ou API) a terminé de s’exécuter.
    • Un utilisateur est mis à jour.
    • Une des notifications suivantes est envoyée:
      • Lettre Demande d'annulation
      • Lettre d'historique de prêt
      • Avis de statut du prêt
      • Lettre Réservation à disposition
    • Une demande de réservation, réservation planifiée, déplacement, numérisation ou traitement interne est créée, fermée ou placée sur le rayon des réservations.
    • Un prêt est créé, retourné ou déclaré perdu.
    • Une notice bibliographique est modifiée.
    • Un exemplaire physique est modifié.
    • (Nouveau en février) Un exemplaire d'une ligne de commande récurrente a été réceptionné.
    Pour une liste complète des évènements qui déclenchent des webhooks, voir Supported Events dans le réseau des développeurs.
    Afin d'activer un webhook, Alma doit disposer d'un profil d'intégration Webhooks configuré (voir ci-dessous).
    Pour les webhooks qui utilisent des notifications, dans le cadre de la création du profil d'intégration, vous activerez les webhooks souhaités dans la table de code Activités des lettres. Cependant, une fois le profil d'intégration créé, vous n'avez plus besoin d'ouvrir la table de code Activité des lettres pour activer d'autres webhooks ou désactiver des webhooks. Vous pouvez facilement le faire dans la table Configuration de lettres :
    webhook for letters.png

    Pour des informations détaillées sur ces webhooks, voir https://developers.exlibrisgroup.com/alma/apis/xsd/rest_webhook_notifications.xsd.

    Configurer un profil d'intégration de webhooks

    Pour configurer un profil d'intégration de type Webhooks :
    1. Sur la page Liste des profils d'intégration (Menu de configuration > Général > Systèmes externes > Profils d'intégration), cliquez sur Ajouter un profil d'intégration. La première page de l'assistant de configuration du profil d'intégration s'ouvre.
    2. Dans la liste déroulante Type d'intégration, choisissez Webhooks et renseignez un code et un nom pour le profil d'intégration.
    3. Cliquez sur Suivant. La seconde page de l'assistant s'ouvre.
      Configurer un profil Webhook.
      Configuration du webhook
    4. Cliquez sur Activer pour activer les profils d'intégration Webhooks. Jusqu'à ce que le profil soit activé, le statut affiche Activation en attente.
    5. Indiquez l'URL de l'auditeur dans le champ URL de l'auditeur Webhooks et son code secret dans le champ Secret. Pour des informations sur les valeurs à saisir ici, consultez la section dédiée à la sécurité dans Webhooks.
    6. Choisissez si le type de message doit être XML ou JSON.
    7. Dans la section Abonnements :
      • Sélectionnez Terminer le traitement pour envoyer un webhook une fois l'exécution d'un traitement terminée (en utilisant l'interface utilisateur d'Alma ou une API).
      • Sélectionnez Notifications pour envoyer un webhook lorsqu'une des notifications ci-dessus est envoyée.
        Sélectionnez Configurer des types de notification pour ouvrir la table de code Activité des lettres et faites défiler la page jusqu'en bas pour activer les webhooks pour ces notifications. Les webhooks qui ont été activés auparavant (que ce soit ici ou dans la table Configuration des lettres) apparaissent comme activés. Les webhooks que vous activez ici apparaissent comme activés dans la table Configuration de lettres. Cliquez sur Enregistrer une fois les notifications souhaitées activées afin de revenir au profil d'intégration. 
        letter activity - activate webhook.png
      • Sélectionnez Utilisateurs pour envoyer un webhook lorsque les informations d'un utilisateur sont mises à jour. Ceci inclut tous les changements effectués relatifs à cet utilisateur dont l'historique est enregistré, y compris les modifications effectuées par le traitement Utilisateurs. Notez que les changements utilisateur effectués en utilisant une API n'envoient pas de webhook. Dans la case Groupes utilisateur, sélectionnez les groupes d'utilisateurs pour lesquels un webhook sera envoyé. Si aucun groupe d'utilisateurs n'est spécifié, un webhook sera envoyé pour tous les groupes d'utilisateurs.
      • Sélectionnez Demandes pour envoyer un webhook lorsqu'une demande de réservation, de réservation planifiée, de déplacement, de numérisation ou de traitement interne est créée, clôturée ou placée sur le rayon des réservations.
      • Sélectionnez Prêts pour envoyer un webhook lorsqu'un prêt est créé, retourné ou déclaré perdu.
      • Sélectionnez Notices bibliographiques pour envoyer un webhook lorsqu'une notice bibliographique est modifiée.
      • Sélectionnez Exemplaires physiques pour envoyer un webhook lorsqu'un exemplaire physique est modifié.
      • Sélectionnez Réceptionner - Ligne de commande récurrente pour envoyer un webhook quand une ligne de commande récurrente est réceptionnée.
    8. Cliquez sur Enregistrer. Le profil que vous avez configuré apparaît dans la Liste des profils d'intégration.
    • Une fois le profil d'intégration défini, vous pouvez sélectionner Consulter le registre depuis la liste d'actions de profils d'intégration. Cette option vous permet de consulter un registre des événements webhook. Cette URL et les éléments de charge de la table peuvent ensuite être fouillés. Vous pouvez afficher le texte de la demande pour chaque demande webhook (l'affichage sera tronqué après 4000 caractères, mais le texte complet de la demande est envoyé à l'interlocuteur.
    • Si une tentative de webhook échoue, des emails sont envoyés à toutes les adresses email indiquées dans l'onglet Informations de contact du profil Webhook. 
    • Dans les environnements de bac à sable Premium, l'URL de l'interlocuteur webhook est supprimée et les profils sont réglés sur le statut inactif. Cette action est effectuée car les actions webhook qui ont lieu dans l'environnement de bac à sable arrivent sur le serveur d'écoute, tout comme les données de production, ce qui entraîne un mélange des données de test et des données de production. Si vous souhaitez activer le profil d'intégration sur un environnement de bac à sable, suivez la procédure indiquée aux étapes 4 et 5 ci-dessus.
    • Was this article helpful?