TMF Outbound Notifications Framework

The Outbound Notifications Framework serves as a standardized mechanism for managing outbound notifications across TMF Open APIs. For Summer ’25, notification framework is available for these TMF APIs.

• TMF 622 v4 Product Ordering Management
• TMF 629 v4 Customer Management
• TMF 632 v4 Party Management
• TMF 637 v4 Product Inventory Management
• TMF 651 v4 Agreement Management

This framework provides a structured approach to capturing, processing, and triggering API calls based on changes to entities within the system.

The framework is responsible for detecting and handling events triggered by create or update operations on an entity. Upon successful CDC event generation, the subscriber processes the event data and calls the appropriate outbound TMF Open API endpoint, as configured within the consumption framework. This framework standardizes outbound notification handling across all TMF Open API implementations, ensuring a scalable, configurable, and efficient mechanism for processing entity-level changes. It also ensures compatibility with entities from both the Salesforce Core platform and CME managed packages.

• Event-Driven Architecture

  • Captures changes occurring at the entity level, triggered by create or update actions.
  • Supports real-time processing of modifications across different entities.

• Dynamic API Invocation

  • Allows seamless integration with TMF Open APIs for further data processing.
  • Supports configurable API endpoints based on entity changes.

• Support for Core and CME Managed Packages

  • Ensures compatibility with entities available on Salesforce Core platform as well as those in managed package.
  • Provides flexibility for various deployment models.

• Delete operation is not supported.
• Notification is not triggered for sub-resources.

• Event subscription is not available through the UI; it must be done using the Tooling API.

The diagram illustrates the Outbound Notifications Framework and how it processes entity changes to trigger external API calls. Here's a breakdown of the flow:

• Process

  • A business process updates the database, leading to modifications in specific entities.

• Change Data Capture (CDC) and Events

  • Monitors the database for changes to configured entities.
  • When an entity is created or updated CDC raises an event.
  • The subscriber, that is listening for change events, receives the notifications from CDC and processes them.

• Outbound Notification Configurations

  • The subscriber cross-references the setup entity (ObjIntegProviderDefMapping) to determine which entities and fields should trigger notifications.
  • The configuration defines the Integration Definition Name, which helps determine the next steps.

• Consumption Framework and Integration Definition

  • Processes the event using a process integration provider and named credentials for authentication.
  • The Integration Definition determines how the event should be handled.
  • By default, the Integration Definition generates the sample payload shown below when invoking the outbound API for the received list of events.

• Call TMF Outbound Notification APIs Based on the configuration, the framework invokes the appropriate TMF Outbound Notification API through endpoints of the MuleSoft Direct Application.. For example: TMF651 v4, supports these event notifications.

For example:

• AgreementCreateEvent
• POST: /api/notification/agreementCreateEvent
• AgreementAttributeValueChangeEvent
• POST: /api/notification/agreementAttributeValueChangeEvent
• AgreementStateChangeEvent (status field)
• POST: /api/notification/agreementStateChangeEvent

This is a sample flow of the TMF651v4 Outbound Notification.

• Automated Data Synchronization: Ensures data consistency with external systems by automatically triggering API calls when entity data is modified.
• Workflow Automation: Enables real-time actions based on business rules, such as notifying external systems upon key entity updates.
• Event-Driven Integrations: Facilitates seamless integration between different TMF Open API implementations by reacting to entity modifications.

These licenses are required for the outbound notification framework. Add-on License:

• CommunicationsCloudAddOn
• IndustriesServiceExcellenceAddOn- (For Integration Definition)

Platform License:

• Communications Cloud Growth

Perform these steps to enable the outbound notification framework in your org.

1. From Setup, enter Communications Cloud in the Quick Find box

2. Navigate to Services Setup within Communications Cloud.

3. Locate the option Enable TMF Notification.

4. Toggle the switch ON to enable notifications or OFF to disable them.

   

5. Create a Named Credential.

• Set the URL to the deployed Mule asset URL from the Anypoint Platform.
• Use the external credentials generated during deployment through Mule Direct.

6. Create Integration Definitions.

   

7. Create a permission set, include External Credential Principal Access in it (as shown in image), and assign the permission set to the autoproc user.

   

8. Add the required information for Integration Definitions. Ensure that your Integration Definitions is active. Perform the following to configure the Standard Integration Definition.

• Select Standard Provider In the Integration Definition creation screen.

  • Choose Standard as the integration type.
  • In the Standard Provider dropdown, select TMFNotificationCalloutIntegrationProvider. This provider is available out-of-the box for the notification framework.

• Enter Attribute Values

  • For Named Credentials: Enter the name of the Named Credential created earlier (created in step 5).
  • For path: Enter the remaining part of the notification URL path. This is appended to the base URL in the Named Credential.
  • For Timeout (ms): Specify the timeout in milliseconds according to your system or integration requirements.

• After saving, click Activate to enable the integration definition.

  

1. Create a subscriber for the create event of the entity, or for specific field names to capture update events. Refer Creating an Object Integration Definition Mapping for sample payload details.

2. Add the remote site settings for the Application URL.

   

To create an Object Integration Definition Mapping, use this:

/services/data/v64.0/tooling/sobjects/ObjIntegProviderDefMapping

To retrieve the Object Integration Definition Mapping use this:

/services/data/v64.0/tooling/sobjects/ObjIntegProviderDefMapping/{ID}