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

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Who can execute the method: administrator

The event.offline.get method returns the first offline events in the queue to the application according to the filter settings. The availability of offline events can be checked via the feature.get method.

The method works only in the context of authorizing the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

filter
array

Record filter. By default, all records are returned without filtering. Filtering is supported by fields: ID, TIMESTAMP_X, EVENT_NAME, MESSAGE_ID with standard operations like =, >, <, <=, and so on.

Important: the operation type is placed before the field name in the filter

order
array

Record sorting. Sorting is supported by the same fields as in the filter; an array of the type [field=>ASC|DESC] is accepted as input. Default is [TIMESTAMP_X:ASC]

limit
integer

Number of records to select. Default is 50

Additional Parameters

Name
type

Description

clear
integer

Values: 0|1 — whether to delete selected records. Default is 1

process_id
string

Process identifier. Used if you need to re-select any unprocessed records from the current process

auth_connector
string

Source key. Used if the auth_connector value was specified in the event.bind method

error
integer

Values: 0|1 — whether to return erroneous records. Default is 0

Note

The method supports multi-threaded parsing. This means several parallel requests to /rest/event.offline.get are permitted (subject to rate limits), and each will receive a different set of records.

Code Examples

How to Use Examples in Documentation

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"=MESSAGE_ID":1,"=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': 1,
        '=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': 1,
            '=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>
try {
    $response = $b24Service
        ->core
        ->call(
            'event.offline.get',
            [
                'filter' => [
                    '=MESSAGE_ID' => 1,
                    '=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": 1,
            "=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' => 1,
            '=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": false,
                "EVENT_ADDITIONAL": false,
                "MESSAGE_ID": "1"
            }
        ]
    },
    "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

Root element of the response

time
time

Information about the request execution time

Error Handling

HTTP status: 403

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

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status

Code

Description

Value

403

ACCESS_DENIED

Access denied!

Method was executed by a non-administrator

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site 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