Custom Hooks for Template Operation

Hook Keys

Hooks are identified by the pattern {methodName}.PreInvoke and {methodName}.PostInvoke:

Hook Lifecycle

For every operation, execution occurs in this order:

• {methodName}.PreInvoke - runs before the core operation
• Core operation - Save / Get / Search / Apply / Delete logic
• {methodName}.PostInvoke - runs after output is fully populated

Implementation Script

Create an Apex class named CPQAppHandlerHookImplementation (outside the managed package) that implements either VlocityOpenInterface or VlocityOpenInterface2. The platform's CpqAppHandlerHookImplementation will automatically discover and delegate to it. Here is the same code for a hook on Save Template:

public class CPQAppHandlerHookImplementation implements
        VlocityOpenInterface {                                                        
        
        public Boolean invokeMethod(String methodName, Map<String, Object>  
        input,          
        Map<String, Object> output,             
        Map<String, Object> options) {                                          
        
        if (methodName == 'saveSalesConfigTemplate.PostInvoke') {             
        onSaveTemplatePost(input, output);
        } else if (methodName == 'applySalesConfigTemplate.PreInvoke') {      
        onApplyTemplatePre(input);                                        
        }                                                                     
        return true;                                                          
        }                                                                         
        
        private void onSaveTemplatePost(Map<String, Object> input,          
        Map<String, Object> output) {
        // Custom logic after a template is saved                             
        // output contains: result.records[0].templateId, success, errorCode  
        }                                                                         
        
        private void onApplyTemplatePre(Map<String, Object> input) {        
        // Custom logic before a template is applied
        // input contains: templateId, cartId, name, asyncMode, pricing,      
        validation                                                                    
        }                                                                         
        }

Message Structure

Each message in the messages array contains:

{                                                            
        "code": "TEMPLATE_NOT_FOUND",                                               
        "severity": "ERROR",                                                        
        "message": "Template with ID 'a1Bxx0000004XyzDEF' not found"                
        }