Oracle Cloud Infrastructure Documentation

Notifications Overview

The Oracle Cloud Infrastructure Notifications service broadcasts (Notifications and Monitoring services) An alert published to all subscriptions in the specified topic. Each message is delivered at least once per subscription. to distributed components through a publish-subscribe pattern, delivering secure, highly reliable, low latency and durable messages for applications hosted on Oracle Cloud Infrastructure and externally. Use Notifications to get notified when event rules are triggered or alarms are breached, or to directly publish a message.

Note

Notifications is not available in Oracle Cloud Infrastructure Government Cloud.

How Notifications Works

The Notifications service enables you to set up communication channels for publishing messages using (Notifications service) A communication channel for sending messages to the subscriptions in the topic. and (Notifications service) An endpoint for a topic; typically a URL or email address. Published messages are sent to each subscription for a topic.. When a message is published to a topic, the Notifications service sends the message to all of the topic's subscriptions.

When a subscriber’s endpoint does not acknowledge receipt of the message, the Notifications service retries delivery. This situation can occur when the endpoint is offline. For example, the email server for an email address may be down.

Delivery retry details

You can change the retry duration for a subscription. For instructions using the Console, see To update the retry duration for a subscription. For the API, use the following operation: UpdateSubscription.

Notifications Concepts

The following concepts are essential to working with Notifications.

message
The content that is published to a topic. Each message is delivered at least once per subscription. Every message sent out as email contains a link to unsubscribe from the related topic.
subscription
An endpoint for a topic. Published messages are sent to each subscription for a topic. For supported subscription protocols, see To create a subscription.
topic
A communication channel for sending messages to the subscriptions in the topic. Each topic name is unique across the tenancy.

Note

Messages sent out as email by the Oracle Cloud Infrastructure Notifications service are processed and delivered through Oracle resources in U.S.-based regions.

Flow of Message Publication

Notifications publishes messages when event rules are triggered, alarms are breached, or someone directly publishes a message.

Event rules: Notifications sends (Notifications and Monitoring services) An alert published to all subscriptions in the specified topic. Each message is delivered at least once per subscription. when rules are triggered. The message is sent to the (Notifications service) A communication channel for sending messages to the subscriptions in the topic. specified in the rule. For example, a message might be configured for new orders received through a customer-facing application. See Managing Rules for Events.

This image shows Notifications in the context of event rules.

Alarms: Notifications sends alarm messages when The trigger rule and query to evaluate and related configuration, such as notification details to use when the trigger is breached. Alarms passively monitor your cloud resources using metrics in Monitoring. are breached. The alarm message is sent to the (Notifications service) A communication channel for sending messages to the subscriptions in the topic. specified in the alarm. For example, an alarm message might be configured for high CPU usage. See Managing Alarms.

This image shows Notifications in the context of alarms.

Direct publication: Notifications sends (Notifications and Monitoring services) An alert published to all subscriptions in the specified topic. Each message is delivered at least once per subscription. when you (or a service or app) publish the messages directly. The message is sent to the (Notifications service) A communication channel for sending messages to the subscriptions in the topic. you specify. See Publishing Messages.

This image shows Notifications as used to directly publish a message.

Availability

Notifications is currently available in the following regions:

Region Name Region Location Region Key
India West (Mumbai) Asia-Pacific: Mumbai, India BOM
South Korea Central (Seoul) Asia-Pacific: Seoul, South Korea ICN
Australia East (Sydney) Asia-Pacific: Sidney, Australia SYD
Japan East (Tokyo) Asia-Pacific: Tokyo, Japan NRT
Canada Southeast (Toronto) Canada: Toronto YYZ
Germany Central (Frankfurt) Europe: Frankfurt, Germany FRA
Switzerland North (Zurich) Europe: Zurich, Switzerland ZRH
Brazil East (Sao Paulo) South America: Sao Paulo GRU
UK South (London) United Kingdom: London LHR
US East (Ashburn) United States: Ashburn, VA IAD
US West (Phoenix) United States: Phoenix, AZ PHX

Service Comparison for Sending Email Messages

Consider the following service features when deciding whether to use the Notifications service or the Email Delivery service to send your email messages. For more information about Email Delivery, see Overview of the Email Delivery Service.

Service Feature Notifications service Email Delivery service
Requires confirmation before sending email. Yes No
Allows email decorations, such as signatures. Yes No
Allows raw email messages. No Yes
Supports MIME attachments. No

Yes

Supports special handling for failed email delivery. No

Yes

Priced for small messages (less than 32 KB, with a 64-KB limit). Yes No
Priced for large messages (greater than 32 KB, with a 2-MB limit). No Yes

Resource Identifiers

Most types of Oracle Cloud Infrastructure resources have a unique, Oracle-assigned identifier called an Oracle Cloud ID (OCID). For information about the OCID format and other ways to identify your resources, see Resource Identifiers.

Moving Topics and Subscriptions to a Different Compartment

You can move topics and subscriptions from one compartment to another. When you move a topic to a new compartment, its associated subscriptions remain in their existing compartment. The same consideration applies when moving a subscription: its associated topic remains in its existing compartment.

After you move the topic or subscription to the new compartment, inherent policies apply immediately and affect access to the moved topic or subscription through the Console. For more information, see Moving Resources to a Different Compartment.

Important

To move resources between compartments, resource users must have sufficient access permissions on the compartment that the resource is being moved to, as well as the current compartment. For more information about permissions for Notifications resources, see Details for the Notifications Service.

Ways to Access Notifications

You can access the Notifications service using the Console (a browser-based interface) or the REST API. Instructions for the Console and API are included in topics throughout this guide. For a list of available SDKs, see Software Development Kits and Command Line Interface.

Console: To access Notifications using the Console, you must use a supported browser. You can use the Console link at the top of this page to go to the sign-in page. You will be prompted to enter your cloud tenant, your user name, and your password. Open the navigation menu. Under Solutions and Platform, go to Application Integration and click Notifications.

API: To access Notifications through API, use Notifications API.

Authentication and Authorization

Each service in Oracle Cloud Infrastructure integrates with IAM for authentication and authorization, for all interfaces (the Console, SDK or CLI, and REST API).

An administrator in your organization needs to set up A collection of users who all need a particular type of access to a set of resources or compartment., A collection of related resources that can be accessed only by certain groups that have been given permission by an administrator in your organization., and An IAM document that specifies who has what type of access to your resources. It is used in different ways: to mean an individual statement written in the policy language; to mean a collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it); and to mean the overall body of policies your organization uses to control access to resources. that control which users can access which services, which resources, and the type of access. For example, the policies control who can create new users, create and manage the cloud network, launch instances, create buckets, download objects, etc. For more information, see Getting Started with Policies. For specific details about writing policies for each of the different services, see Policy Reference.

If you’re a regular user (not an administrator) who needs to use the Oracle Cloud Infrastructure resources that your company owns, contact your administrator to set up a user ID for you. The administrator can confirm which compartment or compartments you should be using.

Administrators: For common policies that give groups access to Notifications, see Allow a group to manage topics, Allow a group to manage topic subscriptions, and Allow a group to publish messages to topics.

Limits on Notifications

See Service Limits for a list of applicable limits and instructions for requesting a limit increase. To set compartment-specific limits on a resource or resource family, administrators can use compartment quotas.