Webhooks

Webhooks enable real-time event-driven communication between IBM OpenPages® and external systems. It empowers developers and administrators to build more responsive and interconnected solutions using OpenPages.
Prerequisite
  • RabbitMQ is a separate product that must be installed and configured before you can use webhooks in OpenPages. For details on setting up RabbitMQ and connecting it to OpenPages, see Setting up OpenPages to connect to RabbitMQ.
  • Applies to: Cloud Pak for Data On premises If the Trigger Framework is not currently enabled in your OpenPages environment, you must configure it as follows:
    1. Sign in with a user account that has administrative privileges for Settings.
    2. Click Open Administration menu Administration menu > System Configuration > Settings.
    3. Expand the Settings tree or search for Disable Triggers to find the setting to disable triggers (/Applications/GRCM/Disable Triggers) and set the Value to false.

After RabbitMQ is installed and configured, you can set up outbound webhooks that automatically trigger HTTP callbacks when specific events occur in objects that you specify within the IBM OpenPages platform.

You can configure webhooks from Open Administration menu Administration menu > Integrations > Webhooks. It requires the SOX > Administration > Webhooks permission to be enabled.

To create a new webhook, you need the following:
  • The endpoint URL and authentication information
  • The object types and events to subscribe to

To add subscriptions to events, you need to first add object types and then link it to the events. Developers in your organization provide the list of the object types and the events they want to listen to. You can add multiple object types and events at once or individually. After adding them, you can manage events for object types in a grid layout.

Enabling and testing connections

A new webhook is not enabled by default. You cannot test a webhook connection until you enable the webhook from the grid on the Webhooks tab.

Important:

As a Service If you're on IBM OpenPages as a Service, wait a few minutes after you enable a webhook and before you test the connection as it may take a few minutes for the egress to be opened.

On Cloud If you're on IBM OpenPages on Cloud and the firewall is not opened, you must contact IBM® support to update the firewall to allow the connection.

Show me how

For a demonstration of how to create a webhook, see the following video.