Skip to main content
ExLibris
  • Subscribe by RSS
  •  

    Ex Libris Knowledge Center

    Webhooks

    Translatable
    Zur Konfiguration eines Webhooks-Definitionsprofils müssen Sie die folgende Rolle innehaben:
    • Allgemeiner Systemadministrator
    Webhooks sind benutzerdefinierte HTTP-Rückruffunktionen, die gewöhnlich durch einen bestimmten Vorgang ausgelöst werden und Informationen über Ergebnisse und Status dieses Vorgangs enthalten.
    Alma kann einen Webhook senden, wenn einer der folgenden Vorgänge eintritt:
    • Ein Prozess wurde abgeschlossen (entweder durch die Alma UI oder durch eine API).
    • Ein Benutzer wird geändert.
    • Eine der folgenden Benachrichtigungen wird gesendet:
      • Vollständiger Brief: Bestellung stornieren
      • Benutzer - Aktivitätsschreiben
      • Benachrichtigung - Ausleihe-Status
      • Bereitstellungsschreiben
      Damit der Webhook aktiviert wird, muss Alma ein Webhook-Integrationsprofil konfiguriert haben (siehe unten).
      Im Rahmen der Erstellung des Integrationsprofils aktivieren Sie die gewünschten Webhooks in der Codetabelle Brief-Aktivität. Sobald das Integrationsprofil erstellt wurde, müssen Sie zum Aktivieren zusätzlicher Webhooks oder zum Deaktivieren von Webhooks die Codetabelle Brief-Aktivität nicht mehr öffnen. Dies können Sie problemlos in der Tabelle Briefe-Konfiguration tun:
      webhook for letters.png

      Für weitere Informationen zu diesen Webhooks, siehe https://developers.exlibrisgroup.com/alma/apis/xsd/rest_webhook_notifications.xsd.
    Um ein Webhooks-Integrationsprofil zu konfigurieren:
    1. Auf der Seite Liste der Integrationsprofile (Konfigurationsmenü > Allgemein > Externe Systeme > Integrationsprofile) klicken Sie auf Neues Integrationsprofil. Die erste Seite des Integrationsprofil-Assistenten öffnet sich.
    2. Wählen Sie aus der Dropdown-Liste Integrationstyp Webhooks aus und geben Sie einen Code und einen Namen für das Integrationsprofil ein.
    3. Wählen Sie Weiter. die zweite Seite des Assistenten wird geöffnet.
      webhooks.png
      Integrationsprofil Webhooks
    4. Klicken Sie auf Aktivieren , um das Webhook Integrationsprofil zu aktivieren. Bis das Profil aktiviert wird, lautet der Status Ausstehende Aktivierung.
    5. Geben Sie die Listener URL für die Webhook Listener URL und den Geheimcode in Secret ein. Information über die hier einzugebenden Werte finden Sie in der technischen Informationstabelle in Webhooks.
    6. Wählen Sie, ob der Meldungstyp XML oderJSON sein soll.
    7. Unter Abonnement:
      • Wählen Sie Prozess beenden, um einen Webhook zu senden, wenn ein Prozess beendet wurde (entweder durch die Alma UI oder durch eine API).
      • Wählen Sie Benachrichtigungen, um einen Webhook zu senden, wenn eine der folgenden Benachrichtigungen gesendet wird: Vollständiger Brief - Bestellung stornieren, Benutzer - Passive Fernleihe - Vollständiges Aktivitätsschreiben, Vollständiger Brief: Änderung des Exemplar-Fälligkeitsdatums, Vollständiges Bereitstellungsschreiben.
        Klicken Sie auf Benachrichtigungstypen konfigurieren, um die Codetabelle Brief-Aktivität zu öffnen, und scrollen Sie ganz nach unten, um die Webhooks für diese Benachrichtigungen zu aktivieren. Die zuvor aktivierten Webhooks (entweder hier oder in der Tabelle Brief-Konfiguration) werden als aktiviert angezeigt. Die hier aktivierten Webhooks werden in der Tabelle Brief-Konfiguration als aktiviert angezeigt. Klicken Sie auf Speichern, wenn Sie die gewünschten Benachrichtigungen aktiviert haben, um zum Integrationsprofil zurückzukehren. 
        letter activity - activate webhook.png
      • Wählen Sie Benutzer, um einen Webhook zu senden, wenn Benutzerinformationen geändert werden. Dazu zählen alle Änderungen von Benutzern, für die eine Historie registriert wird, einschließlich Änderungen durch den Prozess Benutzer. Beachten Sie, bei Benutzer-Änderungen durch eine API kein Webhook gesendet wird. Wählen Sie im Kästchen Benutzergruppen die Benutzergruppen aus, die das Senden eines Webhooks auslösen sollen. Wenn keine Benutzergruppen angegeben werden, wird ein Webhook für alle Benutzergruppen gesendet.
      • Wählen Sie Bestellungen, um einen Webhook zu senden, wenn eine Bereitstellung, eine Buchung, ein Verschieben, eine Digitalisierung oder ein Bearbeitungsauftrag erstellt, geschlossen oder bereitgestellt werden.
      • Wählen Sie Ausleihen, um einen Webhook zu senden, wenn eine Ausleihe erstellt, zurückgegeben oder als verloren erklärt wird.
      • Wählen Sie BIB records, um einen Webhook zu senden, wenn ein Titelsatz geändert wird.
      • Wählen Sie Physische Exemplare, um einen Webhook zu senden, wenn ein physisches Exemplar geändert wird.
    8. Wählen Sie Speichern. Das von Ihnen konfigurierte Profil erscheint in der Integrationsprofil-Liste.
    • Nachdem das Integrationsprofil definiert wurde, können Sie Protokoll ansehen aus der Aktionsliste der Integrationsprofile auswählen. Diese Option ermöglicht es Ihnen, ein Protokoll über Webhook-Vorgänge anzusehen. Die URL- und Nutzdaten-Elemente in der Tabelle können dann durchsucht werden.
    • Wenn Webhook-Versuche fehlschlagen, werden E-Mails an alle E-Mail-Adressen gesendet, die auf der Registerkarte Kontaktinformationen des Webhooks-Profils angegeben sind.
    • In Premium-Sandbox-Umgebungen wird die URL Webhook Listener entfernt und die Profile werden auf Inaktiv eingestellt. Dies liegt daran, dass die Webhook-Aktionen, die in der Sandbox-Umgebung ausgeführt werden, genauso wie die Produktionsdaten auf dem Empfänger-Server landen, wodurch Testdaten und Produktionsdaten gemischt werden. Wenn Sie das Integrationsprofil in einer Sandbox-Umgebung aktivieren möchten, fahren Sie wie in den Schritten 4 und 5 oben beschrieben.
    • Was this article helpful?