7 Sending data to external applications

You can set up Oracle Monetization Cloud to publish data from internal events to external endpoints.

Topics in this document

About publishing event data

You publish event data to automatically notify external systems when specified triggering events happen in Oracle Monetization Cloud. For example, when an account is successfully created or when a customer purchases a product, Oracle Monetization Cloud can send the event data to your customer relationship management (CRM) system.

Oracle Monetization Cloud can automatically publish events when:

  • A customer's account is created

  • A customer's account status is changed

  • A payment request is sent to a customer

  • A customer's payment is processed successfully or fails

  • A customer's balance crosses a threshold

  • A customer's invoice is created

  • A customer's bill is created

  • A cycle forward fee is applied to a customer's account

  • A customer purchases a product

  • A service is added to a customer's account

  • A bundle, charge offer, discount offer, package, or package list is published from Offer Design

Event publishing automatically sends an XML or JSON payload to REST endpoints. For details about the payloads, including samples, see Event publishing reference.

Configuring event publishing endpoints

Use System Configuration to configure event publishing endpoints.

  • To create a new endpoint: Select Event Publishing, select New Endpoint, and then enter the required information described in Endpoint information.

  • To update an existing endpoint: Select Event Publishing, select the name of the endpoint, and then update the information.

Endpoint information

Field Description

Name

The name of your endpoint.

Authentication Type

The authentication type that your endpoint requires. Choose from:

  • Basic Auth
  • OAuth (password grant)
  • OAuth (authorization code grant)

The type you select determines which authentication credentials appear below.

Payload Format

The format of the message payload, either XML or JSON. REST endpoints typically use JSON.

Content Type

The content type your endpoint expects. For example, application/json or application/xml.

Location (URI)

The URI for the endpoint.

Username

The user name for accessing the endpoint.

Required for the Basic Auth and OAuth (password grant) authentication types.

Password

The password for accessing the endpoint.

Required for Basic Auth and OAuth (password grant).

Token URI

The URI from which Oracle Monetization Cloud retrieves a token.

Required for both OAuth authentication types.

Client ID

The client ID your authorization server assigns to Oracle Monetization Cloud.

Required for both OAuth authentication types.

Secret

The client secret assigned to Oracle Monetization Cloud and used to retrieve an authorization token.

Required for both OAuth authentication types.

Authorization URI

The URI from which Oracle Monetization Cloud requests authorization when publishing messages containing a valid token. After entering values here and for Token URI, generate an access code by selecting Obtain Access Code.

Required for OAuth (authorization code grant).

Scope

The OAuth scope that Oracle Monetization Cloud requests access to and that is granted with the token.

Appears for OAuth (authorization code grant).

State

The unique string Oracle Monetization Cloud submits when publishing to an endpoint, guaranteeing Oracle Monetization Cloud as the origin of the message.

Appears for OAuth (authorization code grant).

Redirect URI

The redirect URI destination for the Oracle Monetization Cloud message after the request is authenticated and authorized.

Required for OAuth (authorization code grant).

Sending your event listener endpoint URI to Oracle

Oracle Monetization Cloud maintains an internet protocol (IP) whitelist to ensure that it communicates with external software through only approved endpoint URIs. To enable Oracle Monetization Cloud to communicate with your event listener, you must send Oracle the event listener domain to add to the whitelist.

After you've configured your endpoints for event notifications, submit a service request (SR) to Oracle support and include this information:

  • Explain that you need your outbound notification events endpoint URI added to the Oracle Monetization Cloud IP whitelist
  • The CIDR block or fully-qualified domain name for the endpoint
  • The protocol (http or https) and port

Choosing which events to publish

Use System Configuration to choose which events to publish. Select Event Publishing, select Configure Notification Events, and then select the events to publish.

You can publish any events with the cloud icon:


Icon representing external event publication endpoints.

The events with the email icon send emails to customers. See Sending messages to customers.

  • To change the endpoint an event is published to, select the pencil icon for the event and select the new endpoint.

  • To stop publishing an event, deselect it.

When you're done managing the events, select Save at the top of the page.