Register a New Event Handler event.bind

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: any user

The event.bind method registers a new event handler.

The method works only within the context of application authorization. When called through a webhook, the method returns the WRONG_AUTH_TYPE error.

The following restrictions apply to a user without administrator rights:

offline events are unavailable: a subscription with event_type=offline returns the ACCESS_DENIED error
only the user's own identifier can be specified in auth_type; for another user, the method returns the ACCESS_DENIED error

Note

Bitrix24 sends the event data in a POST request to the handler URL, so the address must be accessible from the internet. How to test a handler is described in the article How to Test Your Handler for Processing Bitrix24 Events.

The method can be called via BX24.callBind.

Note

When an application is deleted, its event handlers are removed; when it is updated, they are retained. If the installer of a new version registers the same handler again, the method returns the ERROR_CORE error. Before registering, check the current handlers with the event.get method. How a new application version is released and what to consider in its installer is described in the Application Updates article.

Events will not be sent to the application until the installation is complete. Check the application installation.

Method Parameters

Required parameters are marked with *

Name `type`	Description
event* `string`	Event code, such as `ONCRMLEADADD`. The event must belong to the application's scope or be a basic event; otherwise, the method returns the `ERROR_EVENT_NOT_FOUND` error. The list of available events is returned by the events method
handler* `string`	Handler URL with the `http` or `https` scheme. The host name must contain a dot, so `localhost` is not accepted. Required for online events; ignored when `event_type=offline`
auth_type `integer`	Identifier of the user under whom the event handler is authorized. By default, for an administrator, it is the user whose action triggered the event; for a user without administrator rights, it is that user. Ignored when `event_type=offline`
event_type `string`	Subscription type: `online` or `offline`. Default is `online`. With `offline`, the event is placed in the offline event queue
auth_connector `string`	Source key for offline events. This key creates a separate queue that does not receive changes made by requests of the application itself with the same `auth_connector`. The same value is passed to the `event.offline.*` methods. The parameter is not available on all plans: check it with the feature.get method using the `rest_auth_connector` code; otherwise, the method returns the `WRONG_LICENSE` error
options `object`	Additional settings for the registered event. The set of fields depends on the event. For the `ONOFFLINEEVENT` event, the `minTimeout` field is supported — the minimum interval between notifications in seconds. Default is 1. More details in the article Notification Frequency

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "event": "ONCRMLEADADD",
            "handler": "https://www.my-domain.com/handler/",
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/event.bind

// 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 } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<boolean>({
            method: 'event.bind',
            params: {
              event: 'ONCRMLEADADD',
              handler: 'https://www.my-domain.com/handler/',
              auth_type: 15,
            },
            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('Handler registered:', result)
          }
        } 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 bindEvent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'event.bind',
                params: {
                  event: 'ONCRMLEADADD',
                  handler: 'https://www.my-domain.com/handler/',
                  auth_type: 15,
                },
                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('Handler registered:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindEvent)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.event.bind(
                event="ONCRMLEADADD",
                handler="https://www.my-domain.com/handler/",
                auth_type=15,
            ).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}")

require_once('crest.php');
        
        $result = CRest::call(
            'event.bind',
            [
                'event' => 'ONCRMLEADADD',
                'handler' => 'https://www.my-domain.com/handler/',
                'auth_type' => 15
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "event.bind", b24.Params{
        	"event":   "ONCRMLEADADD",
        	"handler": "https://www.my-domain.com/handler/",
        })
        if err != nil {
        	return fmt.Errorf("event.bind: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1721296536.908506,
                "finish": 1721296537.007365,
                "duration": 0.09885907173156738,
                "processing": 0.03251290321350098,
                "date_start": "2024-07-18T11:55:36+02:00",
                "date_finish": "2024-07-18T11:55:37+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Success of execution
time `time`	Information about the request execution time

Error Handling

HTTP status: 400, 403

{
            "error":"ERROR_EVENT_NOT_FOUND",
            "error_description":"Event not found"
        }

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_EVENT_NOT_FOUND`	Event not found	The event was not found or does not belong to the application's scope
`400`	`ERROR_ARGUMENT`	Argument 'EVENT' is null or empty	The `event` parameter is not passed
`400`	`ERROR_ARGUMENT`	Argument 'HANDLER' is null or empty	The `handler` parameter is not passed for an online event
`400`	`ERROR_ARGUMENT`	`Value must be one of {online\|offline}`	An invalid `event_type` value is passed
`400`	`ERROR_ARGUMENT`	Offline event cannot be registered for this event.	The event cannot be received offline, such as `ONOFFLINEEVENT`
`400`	`ERROR_WRONG_HANDLER_URL`	Wrong handler URL	The handler URL has no host, or the host name has no dot
`400`	`ERROR_UNSUPPORTED_PROTOCOL`	Unsupported handler protocol	The handler URL scheme is neither `http` nor `https`
`400`	`ERROR_CORE`	Unable to set event handler: Handler already binded	This handler is already registered
`400`	`ERROR_CORE`	Unable to set event handler: Process of binding the handler has already started	The same handler is being registered by a parallel request
`403`	`ACCESS_DENIED`	Access denied! Offline events binding requires administrator access rights	An offline event handler is being registered by a user without administrator rights
`403`	`ACCESS_DENIED`	Access denied! Event binding with AUTH_TYPE requires administrator access rights	A user without administrator rights specified another user in `auth_type`
`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` is passed, but the plan does not support source keys

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 Available Events

How to Test Your Handler

Register a New Event Handler event.bind

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning