Разное

Запуск сценария

Описание метода

Метод запускает сценарий, привязанный к операции, и передает в него дополнительные параметры.

Предварительная настройка

На стороне Mindbox должны быть настроены:

Операция со следующими шагами:
- Клиент — любой шаг идентификации клиента (например, «Авторизованный/Неавторизованный — Получить существующего» и др.). Конкретный шаг и используемые идентификаторы (email, телефон и пр.) выбираются исходя из задачи.
- Действие — Запустить сценарий
Подробнее о создании операций.
Сценарий с запуском по событию «Вызов операции», в котором выбрана операция из п. 1.

Формат запроса

Подробнее о работе с V3 API, URL запросов и заголовках: Документация V3 API.

URL и параметры

POST https://api.mindbox.ru/v3/operations/{sync/async}?endpointId={Идентификатор точки интеграции}&operation={Название операции}&deviceUUID={UUID устройства}

Заголовки

Заголовок	Значение	Обязательное
Content-Type	`application/json; charset=utf-8`	✅
Accept	`application/json`	✅
Authorization	`SecretKey {секретный_ключ_точки_интеграции}`	При настройке «Требуется передача секретного сервисного ключа»
User-Agent	`{User-Agent устройства клиента}`	При настройке «Требуется передача DeviceUUID»
X-Customer-IP	`{IP адрес клиента}`	При настройке «Требуется передача DeviceUUID»

Тело запроса


Code
{
"customer": {
    "email": "<Email>"
},
"triggerMechanics": {
    "customParameters": {
    "системное_имя_переменной_1": "<Значение переменной 1 для сценария из операции>",
    "системное_имя_переменной_2": "<Значение переменной 2 для сценария из операции>",
        }
}
}

customer — идентификатор клиента, по которому шаг «Клиент» найдет его профиль. Поддерживаются email, мобильный телефон и любые другие идентификаторы, настроенные в операции.
Узел customParameters содержит дополнительные переменные сценария. Системное имя переменной и их тип перечислены в настройках операции.

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

Ответ

Поле status показывает результат выполнения запроса.

Пример успешного ответа

Сценарий успешно запущен для переданного клиента.

Обработка ошибок

Список всех стандартных ошибок.

Не передана обязательная переменная операции

Last modified on August 13, 2026

Мониторинг вебхуков

Предварительная настройка

На стороне Mindbox должны быть настроены:

Операция со следующими шагами:

Клиент — любой шаг идентификации клиента (например, «Авторизованный/Неавторизованный — Получить существующего» и др.). Конкретный шаг и используемые идентификаторы (email, телефон и пр.) выбираются исходя из задачи.
Действие — Запустить сценарий

Подробнее о создании операций.

Сценарий с запуском по событию «Вызов операции», в котором выбрана операция из п. 1.