TMF651 v4 Agreement Management - Outbound Notification
Use TMF651 Outbound Notification API for managing agreements, especially in the context of partnerships between partners. Outbound notifications are triggered for these events. Outbound notifications can be configured to be triggered for change events on the parent entity (Contract) as well as for relevant sub-resources, see Supported Sub-Resources for TMF Outbound Notifications for the list of supported sub-resources in scope.
/api/notification/agreementCreateEvent/api/notification/agreementAttributeValueChangeEvent/api/notification/agreementStateChangeEvent(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.
This API has been tested with an external system using TMF-aligned customizations. It may not include all optional fields and may not work out-of-the-box with your system. Customizations will likely be required. We recommend a thorough evaluation to ensure it meets your specific needs.
This API is available in the managed package and Salesforce platform.
- 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
- Platform license: Contract Management and Omnistudio
- Required Addon: ContractManagementAddon, DocGenDesigner
- Enable Salesforce Contracts on the org
- 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 agreement resource and the supported related sub-resources, for all events.
- Access to the target system is authenticated using the OAuth 2.0 Client Credentials grant type.
- 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.
- TMF651 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.
- 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.
The following table summarizes the change events supported for the Contract entity, along with the required configurations to trigger them through the Notification Framework.
When configuring Object Integration Definitions, ensure you use the exact RelatedFieldName values provided in the table below.
| TMF Resource | Salesforce Entity | Scenario | changeEventType Supported | Notification Event Path | RelatedFieldName |
|---|---|---|---|---|---|
| Agreement | Contract | Creation of a Contract record | Create | /api/notification/agreementCreateEvent | "RelatedFieldName":"Id" |
| Updates to attributes of Contract record | Update | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"Id" | ||
| Updates to the Contract.Status attribute | Update | /api/notification/agreementStateChangeEvent | "RelatedFieldName":"Id" |
This is a sample payload sent to the target system endpoint for the event Type: AgreementCreateEvent.
The event notification payload is same for all three events (AgreementCreateEvent, AgreementAttributeValueChangeEvent, AgreementStateChangeEvent). The eventType value will differ between the three events.
| TMF Field | TMF Type | Is it Mandatory ? | Supported | Mappings |
|---|---|---|---|---|
| id | string | No | TRUE | Mule correlation Id |
| eventId | string | No | TRUE | inputPayload.eventId |
| eventTime | string | No | TRUE | inputPayload.commitTimestamp as UTC |
| eventType | string | No | TRUE | "AgreementCreateEvent" or "AgreementAttributeValueChangeEvent" or "AgreementStateChangeEvent" |
| correlationId | string | No | TRUE | inputPayload.correlationId |
| timeOcurred | string | No | TRUE | inputPayload.commitTimestamp as UTC |
| event.agreement | object | Yes | TRUE | TMF651v4 Inbound response payload |
This section outlines the sub-resources within TMF651 for which outbound notifications can be configured for create, update, and delete operations.
- Refer to Assumptions section for essential configuration guidelines and design assumptions required to enable TMF outbound notifications on these sub-resources.
- For each sub-resource listed below, use the RelatedFieldName specified in the table to configure the Object Integration Definition mappings. This ensures that the Salesforce Notification Framework triggers notifications accurately for the corresponding change events.
For each sub-resource listed below, use the RelatedFieldName specified in the table to configure the Object Integration Definition mappings. This ensures the Salesforce Notification Framework triggers notifications accurately for the corresponding change events.
TMF Sub-resource: AgreementItem.ProductOffering
Salesforce entity: Sales Contract Line
| TMF Resource | Salesforce Entity | Scenario | changeEventType Supported | Notification Event Path | RelatedFieldName |
|---|---|---|---|---|---|
| SalesContractLine | SalesContractLine | Addition of a SalesContractLine record to the parent Contract | Create | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" |
| Deletion of a SalesContractLine record from the parent Contract | Delete | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" | ||
| Updates to an existing SalesContractLine record | Update | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" |
Below is a sample payload that is received from the Notification Framework when a new SalesContractLine record is added to the parent Contract.
TMF Sub-resource: AgreementItem.TermOrCondition
Salesforce entity: Obligation
| TMF Resource | Salesforce Entity | Scenario | changeEventType Supported | Notification Event Path | RelatedFieldName |
|---|---|---|---|---|---|
| TermOrCondition | Obligation | Update to an existing Obligation linked to a Contract | Update | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ReferenceObjectId" |
| Addition of a new Obligation to a Contract | Create | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ReferenceObjectId" | ||
| Deletion of an Obligation from a Contract | Delete | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ReferenceObjectId" |
Below is a sample payload that is received from the Notification Framework when an existing Obligation record is deleted.
TMF Sub-resource: AgreementSpecification.Attachment
Salesforce entity: ContractDocumentVersion
| TMF Resource | Salesforce Entity | Scenario | changeEventType Supported | Notification Event Path | RelatedFieldName |
|---|---|---|---|---|---|
| AgreementSpecification | ContractDocumentVersion | Creation of a new Contract Document | Create | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" |
| Updates to an existing Document [example: ContractDocumentVersion.status] | Update | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" | ||
| Deletion of a Contract Document | Delete | /api/notification/agreementAttributeValueChangeEvent | "RelatedFieldName":"ContractId" |
Below is a sample payload that is received from the Notification Framework when an existing document is deleted from a contract.