Retrieve a List of Offline Events With Cleanup event.offline.get

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: basic

Who can execute the method: administrator

The event.offline.get method returns to the application the first records from the offline event queue that match the filter. The method has two modes:

clear=1, the default — returns the records and immediately deletes them from the queue
clear=0 — reserves the records as a batch and returns its process_id. Confirm processing of the batch with the event.offline.clear method, and mark errors with the event.offline.error method

The batch reservation mode is not available on all plans. Check its availability using the feature.get method with the code rest_offline_extended.

The method works only in the context of authorizing the application. Permissions for event methods are described in the Access Permissions section.

Method Parameters

Required parameters are marked with *

Name `type`	Description
filter `object`	Record filter. By default, the method returns all records. You can filter by the fields: `ID`, `TIMESTAMP_X`, `EVENT_NAME`, `MESSAGE_ID`. Specify the operation before the field name: `=`, `>`, `<`, `>=`, `<=`. Without an operation, an exact match is used. Negation `!` is not supported, such a filter returns the `ERROR_ARGUMENT` error. Example: `{">ID": 100, "=EVENT_NAME": "ONCRMLEADADD"}`. The value is a string or a number, arrays are not supported. Pass `TIMESTAMP_X` in ISO 8601 format, for example `2024-07-18T12:32:31+02:00`
order `object`	Record sorting by the same fields as in the filter, in the form `{"field": "ASC"}` or `{"field": "DESC"}`. Default is `{"TIMESTAMP_X": "ASC"}`
limit `integer`	Number of records to select, an integer greater than `0`. Default is 50
clear `integer`	Whether to delete the selected records: `1` — delete immediately, `0` — reserve as a batch. Default is `1`. The value `0` without the `rest_offline_extended` mode returns the `WRONG_LICENSE` error
process_id `string`	Identifier of a previously reserved batch. Pass it to retrieve the batch records that have not been confirmed yet. With `clear=1`, the method deletes the entire batch, including records that were not included in the response due to `limit`. To keep the records, pass `clear=0`
auth_connector `string`	Source key. Pass the same `auth_connector` value as when subscribing with the event.bind method, otherwise the method returns only events without a source. The parameter is not available on all plans: check its availability using the feature.get method with the code `rest_auth_connector`, otherwise the method returns the `WRONG_LICENSE` error
error `integer`	`1` — return only records marked as erroneous by the event.offline.error method, `0` — only records without such a mark. Default is `0`

Note

The method can be called in parallel: each request receives its own set of records that does not overlap with the others. Keep in mind the request rate limits.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"=MESSAGE_ID":"b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3","=EVENT_NAME":"ONCRMLEADADD",">=ID":1},"auth_connector":"BxTest","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/event.offline.get

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type OfflineGetResult = {
          process_id: string | null,
          events: {
            ID: string,
            TIMESTAMP_X: ISODate,
            EVENT_NAME: string,
            EVENT_DATA: unknown,
            EVENT_ADDITIONAL: unknown,
            MESSAGE_ID: string,
          }[],
        }
        
        try {
          const response = await $b24.actions.v2.call.make<OfflineGetResult>({
            method: 'event.offline.get',
            params: {
              filter: {
                '=MESSAGE_ID': 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
                '=EVENT_NAME': 'ONCRMLEADADD',
                '>=ID': 1,
              },
              auth_connector: 'BxTest',
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Offline events:', result.events, 'Process ID:', result.process_id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getOfflineEvents() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'event.offline.get',
                params: {
                  filter: {
                    '=MESSAGE_ID': 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
                    '=EVENT_NAME': 'ONCRMLEADADD',
                    '>=ID': 1,
                  },
                  auth_connector: 'BxTest',
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Offline events:', result.events, 'Process ID:', result.process_id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getOfflineEvents)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.event.offline.get(
                filter={
                    "=MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
                    "=EVENT_NAME": "ONCRMLEADADD",
                    ">=ID": 1,
                },
                auth_connector="BxTest",
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'event.offline.get',
                    [
                        'filter' => [
                            '=MESSAGE_ID' => 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
                            '=EVENT_NAME' => 'ONCRMLEADADD',
                            '>=ID' => 1
                        ],
                        'auth_connector' => 'BxTest'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            "event.offline.get",
            {
                "filter": {
                    "=MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3",
                    "=EVENT_NAME": "ONCRMLEADADD",
                    ">=ID": 1
                },
                "auth_connector": "BxTest"
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'event.offline.get',
            [
                'filter' => [
                    '=MESSAGE_ID' => 'b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3',
                    '=EVENT_NAME' => 'ONCRMLEADADD',
                    '>=ID' => 1
                ],
                'auth_connector' => 'BxTest'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "process_id": null,
                "events": [
                    {
                        "ID": "1",
                        "TIMESTAMP_X": "2024-07-18T12:32:31+02:00",
                        "EVENT_NAME": "ONCRMLEADADD",
                        "EVENT_DATA": {
                            "FIELDS": {
                                "ID": "123"
                            }
                        },
                        "EVENT_ADDITIONAL": {
                            "user_id": "1"
                        },
                        "MESSAGE_ID": "b0c7f7c2a3f1e4d5c6b7a8f9e0d1c2b3"
                    }
                ]
            },
            "time": {
                "start": 1721299720.388504,
                "finish": 1721299720.509809,
                "duration": 0.12130498886108398,
                "processing": 0.008239030838012695,
                "date_start": "2024-07-18T12:48:40+02:00",
                "date_finish": "2024-07-18T12:48:40+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Batch identifier and the selected queue records (detailed description)
time `time`	Information about the request execution time

Result Object

Name `type`	Description
process_id `string`	Batch identifier. Populated if the method is called with `clear=0` or with the `process_id` parameter, otherwise `null`. Pass it to event.offline.clear or event.offline.error
events `array`	Queue records (detailed description). If there are no matching records, an empty array is returned

Element of the Events Array

Name `type`	Description
ID `string`	Identifier of the record in the queue
TIMESTAMP_X `datetime`	Time the event was written to the queue or last repeated
EVENT_NAME `string`	Event code, for example `ONCRMLEADADD`
EVENT_DATA `object` or `boolean`	Event data — the same as passed to the handler of an online event, for example `FIELDS.ID`. If the event has no data, the field is empty: `false` or `null`
EVENT_ADDITIONAL `object`	Event authorization data. The `user_id` field contains the identifier of the user who performed the action. If the action was performed without a user, for example by an agent, `user_id` is `0`
MESSAGE_ID `string`	Record key. A repeated event with the same data updates the unreserved record instead of adding a new one. If the record is already reserved by a batch, the repeat creates a new record. Pass the value in the `message_id` parameter of the event.offline.clear and event.offline.error methods

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`ERROR_ARGUMENT`	Value must be positive integer	The `limit` parameter is less than `1`
`400`	`ERROR_ARGUMENT`	Filter field not allowed: …	A field not from the list was passed in `filter`
`400`	`ERROR_ARGUMENT`	Filter operation not allowed: …	An unsupported operation was passed in `filter`, for example `!`
`400`	`ERROR_ARGUMENT`	The value of an argument '…' has an invalid type	An array was passed in `filter` instead of a string or a number
`400`	`ERROR_ARGUMENT`	The filter is not an array.	The `filter` parameter was not passed as an object
`400`	`ERROR_ARGUMENT`	The order is not an array.	The `order` parameter was not passed as an object
`400`	`ERROR_ARGUMENT`	Order field not allowed: …	A field not from the list was passed in `order`
`400`	`ERROR_ARGUMENT`	`Order direction should be one of {ASC\|DESC}`	A direction other than `ASC` or `DESC` was passed in `order`
`403`	`ACCESS_DENIED`	Access denied!	The method was called by a non-administrator
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	The method was called outside an application, for example, through a webhook
`403`	`WRONG_LICENSE`	This feature is not enabled for the current license: auth_connector	`auth_connector` was passed, but the plan does not support source keys
`403`	`WRONG_LICENSE`	This feature is not enabled for the current license: extended offline events handling	The method was called with `clear=0`, but the `rest_offline_extended` mode is not available

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Get a List of Offline Events

Clear Offline Event Queues

Retrieve a List of Offline Events With Cleanup event.offline.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Element of the Events ArrayElement of the Events Array

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning