API Docs

Webhook

Overview

Webhooks are "user-defined HTTP callbacks". They are usually triggered by some event, and include information on the results or status of that event.
When that event occurs, the source site makes an HTTP request to a configured URI. The target end-point catches the HTTP call, and might take an action according to the received information.

Alma is able to send a webhook when the following occur:
- A job run has finished
- Notification is sent
- User Updated
- Loan events
- User request events
- BIB events
- Inventory events

For a complete list of the codes used in the "event" field see the code-table "Webhook Events", using an API request to: /almaws/v1/conf/code-tables/WebhookEvents

Data Dictionary

Click here to download webhook.xsd

Samples

XML

JSON