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
Who can execute the method: any user
The event.unbind method unregisters a registered event handler.
The method works only within the authorization context of an application. It can work both when authorized as a user with Bitrix24 administration rights and as a regular user. For a user without administrator rights, the method is available with the following restrictions:
- Offline events are unavailable
- Only online event handlers registered for the current user can be deleted
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
event* |
Event name |
|
handler* |
Link to the event handler |
|
auth_type |
User identifier under which the event handler is authorized. Note If you need to remove event handlers set with an empty |
|
event_type |
Values: |
If no parameters are specified, all event handlers that meet the other requirements will be deleted.
Code Examples
How to Use Examples in Documentation
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 event handlers deleted during the call.
{
"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 |
Description |
|
result |
Root element of the response |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied! Offline events unbinding requires administrator access rights"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access denied! Offline events unbinding requires administrator access rights |
The method was launched by a non-administrator when deleting an offline event handler |
|
|
|
Access denied! Event unbinding with AUTH_TYPE requires administrator access rights |
The method was launched by a non-administrator and specified the |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |
See Also
Continue Learning
- Get a List of Available Events
- Register a New Event Handler event.bind
- Retrieve a List of Registered Event Handlers event.get
- Security in Handlers
- Offline Events
- Get a List of Offline Events event.offline.list
- Retrieve a List of Offline Events With Cleanup event.offline.get
- Clear Offline Event Queue event.offline.clear
- Register Offline Event Queue Processing Errors event.offline.error
- Event on New Entries in the Offline Event Queue onOfflineEvent