Unregister Event Handler event.unbind

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.unbind method deletes event handlers that the application registered with the event.bind method. BX24.js provides the BX24.callUnbind wrapper for this method.

The method works only within the authorization context of an application. For a user without administrator rights, the method is available with the following restrictions:

offline events are unavailable: a call with event_type=offline returns the ACCESS_DENIED error
only the user's own online event handlers can be deleted

Method Parameters

Required parameters are marked with *

Name `type`	Description
event* `string`	Event code, for example `ONCRMLEADADD`. The code is case-insensitive
handler* `string`	Handler URL specified at registration. Required for online events. With `event_type=offline`, the value is ignored
auth_type `integer`	User identifier under which the event handler is authorized. Without this parameter, an administrator deletes the handlers of all users, and a user without administrator rights deletes only their own. A user without administrator rights does not need to pass this parameter: if it is passed, only the user's own ID as an integer is allowed, while the string `"15"` or `0` returns the `ACCESS_DENIED` error. With `event_type=offline`, the parameter is ignored Note To delete only the handlers that are authorized on behalf of the user who triggered the event, an administrator passes `auth_type=0`. Handlers with a different `auth_type` remain.
event_type `string`	Subscription type: `online` or `offline`, case-insensitive. Defaults to `online`. With `offline`, the method works with offline events
auth_connector `string`	Source key. Applies only with `event_type=offline`: the method deletes offline handlers with the same `auth_connector` that was passed to event.bind. Without this parameter, the method deletes handlers that have no source key

The method deletes all handlers of the application that match the passed parameters.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

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.unbind

// 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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type EventUnbindResult = {
          count: number
        }
        
        try {
          const response = await $b24.actions.v2.call.make<EventUnbindResult>({
            method: 'event.unbind',
            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('Unbound handlers count:', result.count)
          }
        } 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 unbindEvent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'event.unbind',
                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('Unbound handlers count:', result.count)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', unbindEvent)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.event.unbind(
                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}")

try {
            $eventCode = 'your_event_code'; // Replace with your actual event code
            $handlerUrl = 'https://your.handler.url'; // Replace with your actual handler URL
            $userId = null; // Replace with your actual user ID or leave as null
            $result = $serviceBuilder
                ->getMainScope()
                ->event()
                ->unbind($eventCode, $handlerUrl, $userId);
            print($result->getUnbindedHandlersCount());
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

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

Response Handling

HTTP status: 200

The method returns the number of deleted handlers.

{
            "result": {
                "count": 1
            },
            "time": {
                "start": 1721298360.468008,
                "finish": 1721298360.553977,
                "duration": 0.0859689712524414,
                "processing": 0.0023431777954101562,
                "date_start": "2024-07-18T12:26:00+02:00",
                "date_finish": "2024-07-18T12:26:00+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Deletion result (detailed description)
time `time`	Information about the request execution time

Result Object

Name `type`	Description
count `integer`	Number of deleted handlers. If no matching handlers are found, `0`

Error Handling

HTTP status: 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied! Offline events unbinding requires administrator access rights"
        }

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`	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
`403`	`ACCESS_DENIED`	Access denied! Offline events unbinding requires administrator access rights	The method was called by a non-administrator with `event_type=offline`
`403`	`ACCESS_DENIED`	Access denied! Event unbinding with AUTH_TYPE requires administrator access rights	The method was called by a non-administrator who passed an `auth_type` that is not their own ID as an integer
`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 Handlers

Security

Unregister Event Handler event.unbind

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning