SugarCRM SupportDocumentationSugar DeveloperSugar Developer Guide 8.0ArchitectureLogic HooksAPI Hooksbefore_api_call



The before_api_call hook executes when the v10+ REST Service is about to call the API implementation.


function before_api_call($event, $arguments){}


Name Type Description
event String The name of the logic hook event
arguments Array Additional information related to the event
arguments.api Object The RestService Object
arguments.request Object The RestResponse Object


  • This is a global logic hook where the logic hook reference must be placed in ./custom/modules/logic_hooks.php.
  • This hook can change the method being called and the parameters.
  • This hook should not be used for any type of display output.

Change Log

Version Note
7.0.0RC1 Added before_api_call hook




    $hook_version = 1;
    $hook_array = Array();

    $hook_array['before_api_call'] = Array();
    $hook_array['before_api_call'][] = Array(
        //Processing index. For sorting the array.

        //Label. A string value to identify the hook.
        'before_api_call example', 

        //The PHP file where your class is located.

        //The class the method is in. 

        //The method to call. 




    if (!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');

    class logic_hooks_class
        function before_api_call_method($event, $arguments)



Last modified: 2018-08-02 16:47:18