OnImConnectorStatusDelete Event for Disabling Open Channels
Scope:
imconnectorWho can subscribe: any user
The OnImConnectorStatusDelete event is triggered when a client disables the connector of an external channel on a specific open channel.
Events will not be sent to the application until the installation is complete. Check the application installation
What the Handler Receives
Data is transmitted as a POST request
{
"event": "ONIMCONNECTORSTATUSDELETE",
"event_handler_id": 561,
"data": {
"connector": "myconnector",
"line": 107
},
"ts": 1773761094,
"auth": {
"access_token": "5680b91b0000844000785e072978228d24bd2f",
"expires": 1773764694,
"expires_in": 3600,
"scope": "imconnector, imopenlines",
"domain": "some-domain.bitrix24.com",
"server_endpoint": "https://oauth.bitrix24.tech/rest/",
"status": "F",
"client_endpoint": "https://some-domain.bitrix24.com/rest/",
"member_id": "bac1cd5c8940947a75e0d71b1a84e348",
"user_id": 27,
"application_token": "831c76b092f9f135d9b6b36c3a720757"
}
}
|
Parameter |
Description |
|
event |
Symbolic code of the event. In this case — |
|
event_handler_id |
Identifier of the event handler |
|
data |
Object containing event data. The structure is described below |
|
ts |
Date and time the event was sent from the event queue |
|
auth |
Object with authorization parameters and information about the account where the event occurred. The structure is described below |
Data Parameter
|
Parameter |
Description |
|
connector |
Identifier of the disabled connector |
|
line |
Identifier of the open channel for which the connector was disabled |
Auth Parameter
Required parameters are marked with *
|
Name |
Description |
|
access_token |
Authorization token OAuth 2.0 |
|
expires_in |
Time in seconds until the token expires |
|
scope* |
Scope under which the event occurred |
|
domain* |
Address of Bitrix24 where the event occurred |
|
server_endpoint* |
Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens |
|
status* |
Status of the application that subscribed to this event:
|
|
client_endpoint* |
Common path for REST API method calls for Bitrix24 where the event occurred |
|
member_id* |
Identifier of Bitrix24 where the event occurred |
|
refresh_token |
Token for extending authorization OAuth 2.0 |
|
application_token* |
Token for secure event handling |
Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.
It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.
Continue Learning
- OnImConnectorMessageAdd Event
- When Creating a Dialog OnImConnectorDialogStart
- OnImConnectorMessageUpdate Event
- OnImConnectorMessageDelete Event
- OnImConnectorDialogFinish Event
- OnImConnectorLineDelete Event