Event on Application Uninstallation: onAppUninstall

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

The ONAPPUNINSTALL event is triggered when an application is uninstalled.

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": "ONAPPUNINSTALL",
            "event_handler_id": "13",
            "data": {
                "LANGUAGE_ID": "de",
                "CLEAN": "1"
            },
            "ts": "1466439714",
            "auth": {
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "client_endpoint": "https://some-domain.bitrix24.com/rest/",
                "member_id": "a223c6b3710f85df22e9377d6c4f7553",
                "application_token": "51856fefc120afa4b628cc82d3935cce"
            }
        }
        

Request Parameters

Required parameters are marked with *

Name
type

Description

event*
string

Event character code — ONAPPUNINSTALL

event_handler_id
integer

Event handler ID

data*
object

Data about the uninstalled application.

The structure is described below

ts*
timestamp

Date and time of the event sent from the queue

auth*
object

Object containing authorization parameters and information about the account where the event occurred.

The structure is described below

Parameter data

Name
type

Description

LANGUAGE_ID*
string

Default language of the Bitrix24 account: ru, en and others

CLEAN*
integer

Value of the "Clear application data" option set by the user during uninstallation. Values: 1 or 0

Parameter auth

Name
type

Description

domain*
string

Address of the Bitrix24 account where the event occurred

server_endpoint*
string

Authorization server address for token renewal

client_endpoint*
string

Common path for API method calls to the account

member_id*
string

Unique identifier of the account

application_token*
string

Application token. Compare it with the token retained during installation to make sure the request came from Bitrix24. For more details, see the article Security in Handlers

Tokens are not passed in auth, and the application's API permissions are revoked on uninstallation. You cannot call API methods from the handler of this event.

Continue Learning