TMF632 v4 Party Management - Outbound Notification

Use TMF632 for party management tasks such as creation, update, and event notification. Party can be an individual or an organization that has any kind of relation with the enterprise. Party is created to record individual or organization information before the assignment of any role. Party API manages the data resources such as Individual and Organization. Currently, the API is used to manage Individual resource that represents a single human being (man, woman, or child). This can include customers, employees, or any other person the organization needs to store information about.

Outbound notifications are triggered for these events. They are triggered only for the parent entity (Contact entity).

• /api/notification/individualCreateEvent
• /api/notification/individualStateChangeEvent
• /api/notification/individualAttributeValueChangeEvent(status field)

The user must configure the notification framework to detect CDC events and invoke the relevant TMF Open API implementations that generate the event payloads and forward them to the target systems configured within the API.

• MuleSoft License required: MuleSoft Direct for Communications Cloud (add-on for Communications Cloud) or MuleSoft Anypoint Base Subscription.
• Communications cloud license required: Communications Cloud Growth.

• The notification uses a fire-and-forget approach. Salesforce does not process or store the response in any objects. MuleSoft logs and tracks all received notifications.
• In alignment with TMF v4 standards for event notifications, the system sends the same payload, which includes the full individual resource and the supported related sub-resources, for all events.
• OAuth authentication method used to access the target systems.
• In case of failure when invoking the target system endpoint, the request is retried up to three times, with a two second interval between attempts.
• TMF632 v4 Inbound API response may include optional fields. According to TMF specifications, if the outbound Event Notification payload contains unsupported optional parameters, the downstream system may reject it with a 4xx error. To avoid this, tailor the payload to include only the optional fields supported by the client.
• For the POST payload sent to the external system, ensure that generated response includes only the optional parameters that are supported to prevent a 4xx error response.
• Salesforce and MuleSoft do not have a centralized event hub configured by default. Customers are responsible for setting up their own event hub to manage subscribers. Outbound notifications are generated and sent directly to a single, client-defined target endpoint.

Below are the entities, their scenarios, and the corresponding TMF632 notification events. Customers must create an Integration Definition for each Notification Event Type. See, Create an Integration Definition.

This is a sample payload sent to the target system endpoint for the event Type: IndividualCreateEvent.

The configuration of notification endpoints varies based on whether the Allow users to relate a contact to multiple accounts feature is enabled in the Account Settings.

If the feature is disabled, the notification framework must be configured to trigger the following endpoints when a contact record is created or updated.

• /api/notification/individualCreateEvent: Triggered when a new Contact is created.
• /api/notification/individualStateChangeEvent or /api/notification/individualAttributeValueChangeEvent: Triggered when Contacts are updated.
  • Use /api/notification/individualStateChangeEvent if the update includes a change to the Status field (indicating a state transition).
  • Use /api/notification/individualAttributeValueChangeEvent for all other field updates.

If the feature is enabled, the same endpoints must be triggered, but with an added query parameter: ?contactToMultipleAccountsEnabled=true.

The notification framework must be configured to trigger only the following endpoint when a relationship between the Contact and the Account is created or updated, but this is only if the feature is enabled. /api/notification/individualAttributeValueChangeEvent?contactToMultipleAccountsEnabled=true

When Allow users to relate a contact to multiple accounts feature not enabled and user updates or creates a Contact record, query is sent to Salesforce Contact object with entityId of the Contact object. This is an example of the payload sent by the notification framework.

When Allow users to relate a contact to multiple accounts feature enabled and user updates or creates a Contact record, query is sent to Salesforce Contact and AccountContactRelation objects with entityId of the Contact object. This is the sample outbound notification payload.

When Allow users to relate a contact to multiple accounts feature enabled and user updates or creates the Related Accounts for a given Contact record, query is sent to Salesforce Contact and AccountContactRelation objects with entityId of the AccountContactRelation object. This is the sample outbound notification payload.