Skip to content

Latest commit

 

History

History
104 lines (62 loc) · 6.77 KB

event-notifications-events.md

File metadata and controls

104 lines (62 loc) · 6.77 KB
copyright lastupdated keywords subcollection
years
2024
2024-12-09
Enabling event notifications OpenPages, IBM Cloud,
openpages

{{site.data.keyword.attribute-definition-list}}

Enabling event notifications for {{site.data.keyword.openpages_short}}

{: #event-notifications-events}

As an administrator of {{site.data.keyword.openpages_short}}, you might want to send notifications of events in {{site.data.keyword.openpages_short}} to other users, or human destinations, by using email, SMS, or other supported delivery channels. Additionally, you might want to send these notifications of events to other applications to build logic by using event-driven programming that uses webhooks, for example. This is made possible by the integration between {{site.data.keyword.openpages_short}} and {{site.data.keyword.en_full}}. {: shortdesc}

To send information to {{site.data.keyword.en_short}}, you must connect your {{site.data.keyword.openpages_short}} instance to {{site.data.keyword.en_short}}. For more information about working with {{site.data.keyword.en_short}}, see Getting started with {{site.data.keyword.en_short}}.

How events are collected and sent by {{site.data.keyword.openpages_short}}

{: #event-notifications-how}

When an event of interest takes place in your {{site.data.keyword.openpages_short}} instance, {{site.data.keyword.openpages_short}} communicates with a connected {{site.data.keyword.en_short}} instance to forward a notification to a supported destination.

Currently, {{site.data.keyword.openpages_short}} supports only email destinations.

Events for {{site.data.keyword.openpages_short}}

{: #event-notifications-list}

The following table lists the {{site.data.keyword.openpages_short}} events. All events are under the com.ibm.cloud.openpages.event subtype.

Event type Description
com.ibm.cloud.openpages.event An event is generated when you provision a service instance.
{: caption="Actions that generate event notifications" caption-side="bottom"}

Enabling notifications

{: #event-notifications-enable}

Events that are generated by an instance of the {{site.data.keyword.openpages_short}} service can be forwarded to an {{site.data.keyword.en_short}} service instance that is available in the same account. You can configure only one {{site.data.keyword.openpages_short}} instance to one {{site.data.keyword.en_short}} service instance. However, a single {{site.data.keyword.en_short}} service instance can have many {{site.data.keyword.openpages_short}} instances pointing to it.

The following table shows the {{site.data.keyword.openpages_short}} service instance regions and the {{site.data.keyword.en_short}} service regions that they can forward events to:

{{site.data.keyword.openpages_short}} service instance region Supported {{site.data.keyword.en_short}} service region
AWS US East ( us-east-1 ) IBM Cloud Dallas ( us-south )
AWS Europe ( eu-central-1 ) IBM Cloud Frankfurt ( eu-de )
{: caption="{{site.data.keyword.openpages_short}} service instance regions and their corresponding {{site.data.keyword.en_short}} service regions" caption-side="bottom"}

Adding an {{site.data.keyword.en_short}} service instance

{: #event-notifications-add-service}

Before you can enable notifications for {{site.data.keyword.openpages_short}}, add an {{site.data.keyword.en_short}} service instance{: external} to the same account as your {{site.data.keyword.openpages_short}} instance.

  1. Go to the UI where you manage your {{site.data.keyword.openpages_short}} instance. For more information, see Managing your {{site.data.keyword.openpages_short}} instance.
  2. Click Settings.
  3. In the {{site.data.keyword.en_short}} section, and click Connect.
  4. Expand Before you begin.
  5. Click Create new instance.
  6. On the Event Notifications Pricing page, select a plan, click the checkbox to agree to the license agreement, and then click Create.

Connecting to {{site.data.keyword.en_short}}

{: #event-notifications-enable-ui} {: ui}

Connect {{site.data.keyword.openpages_short}} to the {{site.data.keyword.en_short}} service instance by using Settings > Event Notifications section in the {{site.data.keyword.openpages_short}} UI to connect the services.

  1. Go to the UI where you manage your {{site.data.keyword.openpages_short}} instance. For more information, see Managing your {{site.data.keyword.openpages_short}} instance.
  2. In the {{site.data.keyword.openpages_short}} navigation, click Settings.
  3. In the {{site.data.keyword.en_short}} section, click Connect.
  4. In the Event Notification instances section, click Event Notifications service instance and select the {{site.data.keyword.en_short}} that you created.
  5. To confirm the connection, click Save. The Event Notifications section shows the connection between the {{site.data.keyword.openpages_short}} instance and the Event Notifications instance.
  6. You can verify that a topic and subscription are created for your {{site.data.keyword.openpages_short}} instance in the Event Notification settings by clicking on the Review link.

Your {{site.data.keyword.openpages_short}} instance is ready to send notifications.

Delivering notifications to select destinations

{: #event-notifications-destinations}

After you enable notifications for {{site.data.keyword.openpages_short}}, create topics and subscriptions in {{site.data.keyword.en_short}} so that alerts can be forwarded and delivered.

{{site.data.keyword.openpages_short}} notifications are in HTML format and are intended for the email delivery channel.

Email notifications

{: #event-notifications-email}

You can use the {{site.data.keyword.cloud_notm}} email service as a delivery channel for {{site.data.keyword.openpages_short}} event notifications. Create an {{site.data.keyword.en_short}} subscription between an existing topic and the {{site.data.keyword.cloud_notm}} email service to forward your alerts to various recipients by email. Recipients are automatically set based on the activity within {{site.data.keyword.openpages_short}} that caused the notification to be created.

These emails originate from no-reply@cloud.ibm.com or event-notifications@cloud.ibm.com, but you can specify your own reply-to address.