Событие при оплате приложения onAppPayment

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: базовый

Кто может подписаться: любой пользователь

Событие ONAPPPAYMENT вызывается при оплате или продлении оплаченного периода приложения. Битрикс24 получает новый статус от Маркета, например, когда пользователь открывает приложение или список установленных приложений. Поэтому событие может прийти позже самой оплаты. Событие приходит только в то приложение, которое оплатили.

События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения.

Что получает обработчик

Данные передаются в виде POST-запроса

{
    "event": "ONAPPPAYMENT",
    "event_handler_id": "14",
    "data": {
        "CODE": "bitrix.gds_company",
        "VERSION": "1",
        "STATUS": "S",
        "PAYMENT_EXPIRED": "N",
        "DAYS": "28"
    },
    "ts": "1466439714",
    "auth": {
        "domain": "some-domain.bitrix24.ru",
        "server_endpoint": "https://oauth.bitrix24.tech/rest/",
        "client_endpoint": "https://some-domain.bitrix24.ru/rest/",
        "member_id": "a223c6b3710f85df22e9377d6c4f7553",
        "application_token": "51856fefc120afa4b628cc82d3935cce"
    }
}

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

Обязательные параметры отмечены *

Название
тип

Описание

event*
string

Символьный код события — ONAPPPAYMENT

event_handler_id
integer

Идентификатор обработчика события

data*
object

Данные о статусе оплаты приложения.

Структура описана ниже

ts*
timestamp

Дата и время отправки события из очереди

auth*
object

Объект с параметрами авторизации и данными о Битрикс24, на котором произошло событие.

Структура описана ниже

Параметр data

Название
тип

Описание

CODE*
string

Код приложения

VERSION*
string

Установленная версия приложения

STATUS*
string

Статус приложения в Битрикс24.

Возможные значения:

  • L — локальное приложение
  • F — бесплатное тиражное приложение
  • S — подписное тиражное приложение

PAYMENT_EXPIRED*
string

Истек ли оплаченный период приложения. Всегда N: при истекшем периоде событие не отправляется

DAYS
integer

Количество дней, оставшееся до конца оплаченного периода. Если у приложения нет даты окончания периода, ключ не передается

Параметр auth

Название
тип

Описание

domain*
string

Адрес Битрикс24, на котором произошло событие

server_endpoint*
string

Адрес сервера авторизации для обновления токена

client_endpoint*
string

Общий путь для вызовов методов API Битрикс24

member_id*
string

Уникальный идентификатор Битрикс24

application_token*
string

Токен приложения. Сравните его с токеном, сохраненным при установке, чтобы убедиться, что запрос пришел из Битрикс24. Подробнее — в статье Безопасность в обработчиках

Если событие удалось привязать к пользователю, в auth дополнительно приходят access_token, expires_in, scope и status, подробнее. Ключ refresh_token для этого события не передается.

Продолжите изучение

Предыдущая
При удалении приложения
Следующая
При решении администратора по запросу метода с подтверждением