How to Test Your Handler for Bitrix24 Event Processing

After registering the handler ONAPPTEST, the method event.test is called manually. This triggers the specified event and allows you to verify that the handler is indeed capable of receiving event data.

Step 1

Create a file named handler.php on your server. Ensure it is accessible from the internet. Next to the file, create a folder named \log.

Code for the file handler.php.

How to Use Examples in Documentation

<?php
        file_put_contents(
            __DIR__ . '/log/' . time() . '.txt',
            var_export($_REQUEST, true)
        );
        ?>

Step 2

Register the event by specifying the path to the file created in Step 1 in the handler field.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"event":"ONAPPTEST","handler":"https://example.com/handler.php","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/event.bind
        
BX24.callMethod(
            'event.bind',
            {
                'event': 'ONAPPTEST',
                'handler': 'https://example.com/handler.php'
            },
            function(eventBind) {
                if (eventBind.data()) {
                    console.log('event bind successful');
                }
            }
        );
        
<?php
        $eventBind = CRest::call(
            'event.bind',
            [
                'event' => 'ONAPPTEST',
                'handler' => 'https://example.com/handler.php'
            ]
        );
        if($eventBind['result'])
        {
            echo 'event bind successful';
        }
        ?>

Step 3

Trigger the event by calling the method with arbitrary data.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"any":"data","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/event.test
        
BX24.callMethod(
            'event.test',
            {
                'any': 'data'
            },
            function(result) {
                if (result.data()) {
                    console.log('successful');
                }
            }
        );
        
<?php
        $result = CRest::call(
            'event.test',
            [
                'any' => 'data'
            ]
        );
        if($result['result'])
        {
            echo 'successful';
        }
        ?>

Result

Upon a successful call, a file with standard event data is created in the \log folder.

array (
            'event' => 'ONAPPTEST',
            'data' => 
            array (
                'QUERY' => 
                array (
                    'any' => 'data',
                ),
                'LANGUAGE_ID' => 'en',
            ),
            'ts' => '1573120286',
            'auth' => array (...)
        )
Previous
Register a Handler
Next
Get a List of Handlers