Webhooks

Panoramica e istruzioni per configurare un profilo d'integrazione di tipo Webhooks.

Per configurare un profilo di definizione webhook, è necessario disporre del seguente ruolo:

Amministratore di Sistema Generale

I webhook sono callback HTTP definiti dall'utente che vengono solitamente attivati da un evento e includono informazioni sui risultati o sullo stato di quell'evento.

Alma è in grado di inviare un webhook quando si verifica uno dei seguenti eventi:

L'esecuzione di un processo è terminata (utilizzando l'UI di Alma o un'API).
Un utente è stato aggiornato.
One of the following notifications is sent:
- Lettera di richiesta cancellazione
- Lettera Attività Prestiti
- Notizia status del prestito
- Scaffale in attesa comunicazione
Una richiesta di attesa, prenotazione, spostamento, digitalizzazione o work order viene creata, chiusa o posizionata sullo scaffale prenotazioni.
Un prestito viene creato, restituito o dichiarato Smarrito.
A bibliographic record is changed.
Una copia fisica è stata modificata.
An item from a continuous PO line was received.

For a complete list of events that trigger webhooks, see Supported Events in the Developer Network.

Per Attivare un webhook, Alma deve avere un profilo d'integrazione Webhooks configurato (vedi sotto).

For webhooks that use notifications, as part of the integration profile creation, activate the desired webhooks in the Letter Activity code table. However, once the integration profile is created, you can activate additional webhooks or deactivate webhooks from the Letters Configuration table. L'opzione di comunicazione dell'attività di prestito nella pagina dell'attività di comunicazione.

Configurazione lettera

For detailed information on these webhooks, see Developer Network.

Configuring a Webhooks Integration Profile

To configure an integration profile of Webhooks type:

On the Integration Profile List page (Configuration Menu > General > External Systems > Integration Profiles), select Add Integration Profile. Si apre la prima pagina della procedura guidata del profilo d'integrazione.
Dall'elenco a discesa Tipo di integrazione, selezioni Webhooks e inserisca un codice e un nome per il profilo.
Seleziona Avanti. Si apre la seconda pagina della procedura guidata.
Webhook Configuration
Selezioni Attiva per attivare il profilo d'integrazione dei webhook. Finché il profilo non viene attivato, lo stato è Attivazione in sospeso.
Inserisca l'URL del listener per l'URL del listener del webhook e il codice segreto in Segreto. For information on the values to be entered here, see the Security section in Webhooks.
Selezionare se il tipo di messaggio deve essere XML o JSON.
Sotto abbonamento:
- Selezionare Fine processo per inviare un webhook al termine dell'esecuzione di un processo (utilizzando l'UI di Alma o un'API).
- Select Notifications to send a webhook when one of the notifications listed above is sent. Select Configure Notification Types to open the Letter Activity code table, and scroll to the very bottom to activate the webhooks for these notifications. The webhooks that were previously activated (either here or in the Letters Configuration table) show as activated; and the webhooks you activate here are displayed as activated in the Letters Configuration table. Select Save when you have activated the desired notifications to go back to the integration profile.
- Selezionare Utente per inviare un webhook quando le informazioni sull'Utente vengono aggiornate. Sono incluse tutte le modifiche degli Utenti per le quali è registrato lo storico, incluse le modifiche apportate dal processo Utenti. Nota che le modifiche apportate dall'Utente tramite un'API non causano l'invio di un webhook. Nella casella Gruppi utente, selezioni i gruppi utente che attivano l'invio di un webhook. If no user groups are specified, a webhook is sent for all user groups.
- Selezionare richiesta per inviare un webhook quando una richiesta di attesa, prenotazione, spostamento, digitalizzazione o work order viene creata, chiusa o posizionata sullo scaffale delle richieste di attesa.
- Selezioni Prestiti per inviare un webhook quando un prestito viene creato, restituito o dichiarato smarrito.
- Selezioni BIB (record bibliografico) per inviare un webhook quando un record bibliografico viene modificato.
- Selezioni copia fisica per inviare un webhook quando una copia fisica viene modificata.
- Select Receive - continuous PO line to send a webhook when a continuous PO line is received.
- Select Resource sharing lending requests to send a webhook for lending resource sharing requests.
Seleziona Salva. Il profilo che hai configurato appare nella Lista dei profili d'integrazione.

Dopo che il profilo d'integrazione è stato definito, è possibile selezionare Visualizza registro dalla lista delle azioni del profilo d'integrazione. Questa opzione consente di vista un registro degli Evento del webhook. È quindi possibile effettuare ricerche negli elementi URL e payload della tabella. È possibile visualizzare il corpo della richiesta per ogni richiesta webhook (la visualizzazione viene troncata dopo 4000 caratteri, ma il corpo completo della richiesta viene inviato al listener).
Se i tentativi di webhook falliscono, le email vengono inviate a tutti gli indirizzi email indicati nella tab Informazioni di contatto del profilo Webhook.
In Premium Sandbox environments, the Webhook Listener URL is removed and the profiles are set to inactive. Questo accade perché le azioni webhook che avvengono nell'ambiente Sandbox arrivano sul server listener nello stesso modo dei dati di produzione, il che porta a mescolare i dati di test con quelli di produzione. Se desideri Attiva il profilo d'integrazione in un ambiente Sandbox, procedi come indicato nei passaggi 4 e 5 sopra.