Events

NAVIGATE CONTENT
Ex Libris Developer Network Alma Documentation Integrations Webhooks Events

Supported Events

Event NameDescriptionBody payload
JOB_ENDWhen jobs in the system are completed, either successfully or with errors.

This webhook is sent for both manual and scheduled jobs, for jobs triggered in Alma UI or by API.

rest_job_instance
NOTIFICATIONWhen one of the following notifications is sent: FulCancelRequestLetter, FulUserBorrowingActivityLetter, FulItemChangeDueDateLetter, FulPlaceOnHoldShelfLetter.
Webhooks for these letters must be activated in the Letter Activity mapping table.		rest_webhook_notifications
USERWhen user information is updated. This includes all user changes that are registered in the history tab of the user record, including changes by SIS or the update-user job.
Note that user changes by API do not cause a webhook.
It is possible to define (on the Webhook integration profile) which user groups will trigger the webhook. If not specified – all user groups will be included.		webhook_user_extended
LOANWhen the following loan-related events occur:

  • Loan created (check-out)
  • Loan returned (check-in)
  • Loan has been declared lost
  • Loan has been claimed returned
  • Loan renewed
  • Loan due date has changed

The specific event will be specified in event field of the webhook structure.

rest_item_loan
REQUESTWhen the following user request related events occur:

  • Request created
  • Request canceled
  • Request closed
  • Request placed on shelf

The specific event will be specified in event field of the webhook structure.
Note that requests of the following types are included: HOLD, BOOKING, MOVE, DIGITIZATION, WORK_ORDER.

rest_user_request
BIBWhen the following events occur:

  • Record created
  • Record updated
  • Record deleted

The specific event will be specified in event field of the webhook structure.

rest_bib
ITEMWhen the following events occur:

  • Item created
  • Item updated (or received)
  • Item deleted

The specific event will be specified in event field of the webhook structure.

rest_item

Configuring Webhook Events

In order to trigger a webhook in the above events, the “SUBSCRIPTIONS” section of the Webhook integration profile should be configured.

For example:

This section defines which events of the above types will trigger webhooks. Fore details regarding the Webhook integration profile, see Alma OLH.

Configuration and setup

To enable webhooks in Alma, the following is required:

  1. Create an HTTPS endpoint which Alma will call with the relevant information.
  2. Configure a “Webhook” integration profile in Alma, see Online Help.

Note that in order to activate the integration, Alma will send a “challenge” message. For more information, see Anatomy of a Webhook.

The following diagram illustrates the workflow: