Extensibility for TMF APIs

Salesforce’s TMF API extensibility framework enables customers to modify standard TMF-compliant APIs to meet specific business requirements while maintaining interoperability and scalability. Customers extend TMF schemas through the TMF extension model, and Salesforce provides a backend framework that supports custom mappings, validations, transformations, and lifecycle hooks.

This framework enables customers to implement custom logic and additional attributes across TMF operations while adhering to platform guidelines for scalability, data integrity, and compliance.

Key Features

  • Flexible Field and Entity Mapping

    • Remap TMF payload fields to different Salesforce fields or objects
    • Support both standard and custom entities
    • Extend responses by adding or reshaping fields
  • Attribute Extensibility

    • Allow customers to introduce additional TMF fields or sub-resources
    • Map newly added schema elements to Salesforce data structures
  • Advanced Query Extensibility

    • Support custom filtering, sorting, and pagination
    • Enable object-level query extensions
  • Custom Validations

    • Allow business-specific validation rules to be plugged into the request lifecycle
    • Support pre- and post-processing validation logic
  • Transformations and Execution Hooks

    • Provide lifecycle hooks for request/response transformation
    • Support overrides for core transformation, pre-processing, and post-processing logic
  • Inbound and Outbound API Extensibility

    • Apply custom logic to incoming API requests and outgoing API responses
    • Enable modifications for TMF (GET/POST/PATCH/DELETE) operations

Architecture

The following block diagram provides a high-level overview of how the various components are involved in handling extensibility for TMF APIs. Extensibility

To know more about Apex and GraphQL:

Available In

From Spring'26, extensibility is implemented for TMF629 v4 Customer Management API available in the Salesforce platform.

From Summer'26, extensibility is implemented for the following TMF APIs.

From Winter'27, extensibility is implemented for the following TMF APIs.

Prerequisites

  • The CommsCloud license must be enabled to invoke the TMF629 API.
<!--## Execution Flow The following block diagram depicts the end-to-end execution flow of a TMF API request, emphasizing the extensibility features of the Communications Cloud platform, where Apex-based hooks allow customization before and after core processing. ![Extensibility Flow](../../../../media/extenibility_callflow.png "Extensibility Flow") - Client sends TMF request - Communications cloud receives the request - Java service identifies TMF interface and locates active Apex implementation - Apex class executes custom logic prior to request processing - Performs pre-processing validation checks - Applies custom logic to adjust the query parameters - Returns GraphQL modification instructions - Java builds GraphQL Query using Apex JSON, executes GraphQL in Salesforce platform - Apex class executes custom logic after request processing - Receives core results and default response - Enriches/transforms response - Java serializes and sends final API response-->