events — метод REST API Битрикс24

Описание

Метод events возвращает общий список доступных событий.

Метод работает только в контексте авторизации приложения.

Параметры

SCOPE string необязательный

Метод вернет события, принадлежащие указанному разрешению

FULL boolean необязательный

Метод вернет весь список событий. Параметр будет проигнорирован, если будет передан параметр SCOPE

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "SCOPE": "user",
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/events

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "FULL": true,
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/events

BX24.callMethod(
    "events",
    {
        "SCOPE": "user"
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

BX24.callMethod(
    "events",
    {
        "FULL": true
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.events(
        scope="user",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.events(
        full=True,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

require_once('crest.php');

$result = CRest::call(
    'events',
    [
        'SCOPE' => 'user'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

require_once('crest.php');

$result = CRest::call(
    'events',
    [
        'FULL' => true
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

Ответ

HTTP-статус: 200

{
    "result":[
        "ONAPPUNINSTALL",
        "ONAPPINSTALL",
        "ONAPPUPDATE",
        "ONAPPPAYMENT",
        "ONAPPTEST",
        "ONAPPMETHODCONFIRM",
        "ONOFFLINEEVENT",
        "ONUSERADD",
        "ONCRMINVOICEADD",
        "ONCRMINVOICEUPDATE",
        "ONCRMINVOICEDELETE",
        "ONCRMINVOICESETSTATUS",
        "ONCRMLEADADD",
        "ONCRMLEADUPDATE",
        "ONCRMLEADDELETE",
        "ONCRMLEADUSERFIELDADD",
        "ONCRMLEADUSERFIELDUPDATE",
        "ONCRMLEADUSERFIELDDELETE",
        "ONCRMLEADUSERFIELDSETENUMVALUES",
        "ONCRMDEALADD",
        "ONCRMDEALUPDATE",
        "ONCRMDEALDELETE",
        "ONCRMDEALMOVETOCATEGORY",
        "ONCRMDEALUSERFIELDADD",
        "ONCRMDEALUSERFIELDUPDATE",
        "ONCRMDEALUSERFIELDDELETE",
        "ONCRMDEALUSERFIELDSETENUMVALUES",
        "ONCRMCOMPANYADD",
        "ONCRMCOMPANYUPDATE",
        "ONCRMCOMPANYDELETE",
        "ONCRMCOMPANYUSERFIELDADD",
        "ONCRMCOMPANYUSERFIELDUPDATE",
        "ONCRMCOMPANYUSERFIELDDELETE",
        "ONCRMCOMPANYUSERFIELDSETENUMVALUES",
        "ONCRMCONTACTADD",
        "ONCRMCONTACTUPDATE",
        "ONCRMCONTACTDELETE",
        "ONCRMCONTACTUSERFIELDADD",
        "ONCRMCONTACTUSERFIELDUPDATE",
        "ONCRMCONTACTUSERFIELDDELETE",
        "ONCRMCONTACTUSERFIELDSETENUMVALUES",
        "ONCRMQUOTEADD",
        "ONCRMQUOTEUPDATE",
        "ONCRMQUOTEDELETE",
        "ONCRMQUOTEUSERFIELDADD",
        "ONCRMQUOTEUSERFIELDUPDATE",
        "ONCRMQUOTEUSERFIELDDELETE",
        "ONCRMQUOTEUSERFIELDSETENUMVALUES",
        "ONCRMINVOICEUSERFIELDADD",
        "ONCRMINVOICEUSERFIELDUPDATE",
        "ONCRMINVOICEUSERFIELDDELETE",
        "ONCRMINVOICEUSERFIELDSETENUMVALUES",
        "ONCRMCURRENCYADD",
        "ONCRMCURRENCYUPDATE",
        "ONCRMCURRENCYDELETE",
        "ONCRMPRODUCTADD",
        "ONCRMPRODUCTUPDATE",
        "ONCRMPRODUCTDELETE",
        "ONCRMPRODUCTPROPERTYADD",
        "ONCRMPRODUCTPROPERTYUPDATE",
        "ONCRMPRODUCTPROPERTYDELETE",
        "ONCRMPRODUCTSECTIONADD",
        "ONCRMPRODUCTSECTIONUPDATE",
        "ONCRMPRODUCTSECTIONDELETE",
        "ONCRMACTIVITYADD",
        "ONCRMACTIVITYUPDATE",
        "ONCRMACTIVITYDELETE",
        "ONCRMREQUISITEADD",
        "ONCRMREQUISITEUPDATE",
        "ONCRMREQUISITEDELETE",
        "ONCRMREQUISITEUSERFIELDADD",
        "ONCRMREQUISITEUSERFIELDUPDATE",
        "ONCRMREQUISITEUSERFIELDDELETE",
        "ONCRMREQUISITEUSERFIELDSETENUMVALUES",
        "ONCRMBANKDETAILADD",
        "ONCRMBANKDETAILUPDATE",
        "ONCRMBANKDETAILDELETE",
        "ONCRMADDRESSREGISTER",
        "ONCRMADDRESSUNREGISTER",
        "ONCRMMEASUREADD",
        "ONCRMMEASUREUPDATE",
        "ONCRMMEASUREDELETE",
        "ONCRMDEALRECURRINGADD",
        "ONCRMDEALRECURRINGUPDATE",
        "ONCRMDEALRECURRINGDELETE",
        "ONCRMDEALRECURRINGEXPOSE",
        "ONCRMINVOICERECURRINGADD",
        "ONCRMINVOICERECURRINGUPDATE",
        "ONCRMINVOICERECURRINGDELETE",
        "ONCRMINVOICERECURRINGEXPOSE",
        "ONCRMTIMELINECOMMENTADD",
        "ONCRMTIMELINECOMMENTUPDATE",
        "ONCRMTIMELINECOMMENTDELETE",
        "ONCRMDYNAMICITEMADD",
        "ONCRMDYNAMICITEMUPDATE",
        "ONCRMDYNAMICITEMDELETE",
        "ONCRMDYNAMICITEMADD_147",
        "ONCRMDYNAMICITEMUPDATE_147",
        "ONCRMDYNAMICITEMDELETE_147",
        "ONCRMTYPEADD",
        "ONCRMTYPEUPDATE",
        "ONCRMTYPEDELETE",
        "ONCRMDOCUMENTGENERATORDOCUMENTADD",
        "ONCRMDOCUMENTGENERATORDOCUMENTUPDATE",
        "ONCRMDOCUMENTGENERATORDOCUMENTDELETE",
        "ONTASKADD",
        "ONTASKUPDATE",
        "ONTASKDELETE",
        "ONTASKCOMMENTADD",
        "ONTASKCOMMENTUPDATE",
        "ONTASKCOMMENTDELETE"
    ]
}

Возвращаемые данные

result object

Корневой элемент ответа