Перейти к основному контенту

Триггеры

Функция позволяющая приводить в систему список некоторых действий или событий.


Логика запуска триггера описана на примере установки триггера.

Триггеры можно создавать в разделе главного меню Настройки бота подраздел Триггеры. 

image.png

На экранной форме нажать кнопку Новый триггер

image.png

Пример 1

image.png

image.png

Создадим триггер без подписки на событие, для этого заполним следующие параметры:

  • Наименование триггера - текстовое интуитивно понятное название триггера.
  • Код - Дополнительный уникальный идентификатор. Используется для поиска текущего объекта, например, в JavaScript функциях.
  • Список событий, на которые может быть подписан триггер с названием объекта, который будет подписан на данный тип события (например полное название тэга, контекста, атрибута и т.д).:
    • Любое изменение Лида
    • Изменение статуса Лида
    • Изменение (добавление или удаление) Тэга Лида
    • Изменение (добавление или удаление) Контекста Лида
    • Изменение Атрибута Лида
    • Любое изменение в Заказе
  • JavaScript условие запуска Скрипта/Триггера - Условие при котором происходит активация скрипта.image.png

Есть возможность выбора скрипта который будет срабатывать при соответствию условий или срабатывать при не соответствию условий заданных выше.

Выполняется добавление в очередь на запуск привязанного скрипта. В планировщике в установленное время выполняется запуск указанного Скрипта. 

  • Добавить тэги - Дополнительные теги скрипта.
  • Удалить тэги - Удалить теги оригинального скрипта.
  • Контекст запускаемого скрипта/триггера  - От лица кого будет происходить активация скрипта. (точно ли??)
  • Запускаемый скрипт - Какой скрипт будет вызываться триггером.
  • Запускаемый триггер - значение выбирается из списка созданных триггеров.

Выполняется добавление в очередь на запуск привязанного триггера. В планировщике в установленное время выполняется запуск указанного Триггера. Если для запуска указан другой триггер, то проверка условия будет выполнена перед запуском второго триггера, т.е. по расписанию планировщика.

Для запуска могут быть указаны как Скрипт, так и Триггер одновременно.

  • Запустить указанный Скрипт/Триггер в - указывается дата и время, в которое будет выполнен запуск триггера/скрипта точно в указанное время (с погрешностью в 1 минуту).
  • Запустить указанный Скрипт/Триггер через (минут) - числовое значение в минутах, через которое будет выполнен запуск триггера/скрипта, спустя указанное количество минут. 

image.png

Параметр Запустить указанный Скрипт/Триггер через (минут) игнорируется, если указано точное время запуска, т.е. если указан параметр Запустить указанный Скрипт/Триггер в.

  • JavaScript условие запуска Скрипта/Триггера - условие, при выполнении которого произойдет запуск триггера.

Если запуск триггера должен быть выполнен как отложенный по времени (указано время запуска или время, через которое нужно запустить триггер), то проверка JS условия текущего триггера выполняется до запуска триггера, а не в момент наступления указанного времени.

Если поле JS условия пусто, то оно всегда истинно при проверке.

Нажать кнопку Создать.

image.png

При редактировании существующего триггера появляется галка включен. Что позволяет деактивировать ненужный в данный момент триггер. 

image.png

На экранной форме в разделе Триггеры будет располагаться список созданных триггеров для данного бота.

image.png

Этапы запуска и установки триггера:

  • Наступление события для запуска триггера или отложенный запуск по расписанию.

  • Проверка JS условия.

  • Запуск связанного Скрипта / Триггера или добавление отложенного запуска в планировщик.

В разделе Триггеры располагается список созданных триггеров для данного бота с доступными операциями:

  • Редактировать триггер
  • Сообщения полученные подписчиками в результате выполнения триггера
  • Подписчики получившие сообщение в результате выполнения триггера
  • Удалить триггер

image.png

JS методы для работы с триггерами

С триггерами так же можно работать изс помощью JS следующимиметодов. методамиВсе объектаметоды и их описание вы можете посмотреть в bot:

Название метода Метод Планирование триггера bot.scheduleTrigger(?int $triggerId, ?int $leadId, ?int $ticketId = null, $jobParams = []): bool Планирование триггераСправочнике по кодуфункциям bot.runTriggerByCodeForLead(?string $triggerCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool Планирование триггера по коду для последнего лида персоны bot.runTriggerByCodeForPerson(?string $triggerCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool Удалить триггеры для лида bot.clearTriggerJobsForLead(?int $leadId, ?int $ticketId = null): bool Удалить триггеры для всех лидов персоны

bot.clearTriggerJobsForAllPersonLeads(?int $personId, ?int $ticketId = null): boolJS

Получить ID триггера по наименованию

bot.getTriggerIdByName(?string $triggerName): ?int

Получить ID Триггера по Коду

bot.getTriggerIdByCode(?string $triggerCode): ?int

Запустить триггер для лида по ID триггера

bot.runTriggerForLead(?int $triggerId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool

Запустить триггер для лида по наименованию

bot.runTriggerByNameForLead(?string $triggerName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool

Запустить триггер для персоны по ID

bot.runTriggerForPerson(?int $triggerId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool

Запустить триггер для персоны по наименованию

bot.runTriggerByNameForPerson(?string $triggerName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = []): bool

Очистить джобы по id триггера

bot.clearTriggerJobsById(?int $triggerId, ?int $leadId = null): bool

Очистить джобы по наименованию триггера

bot.clearTriggerJobsByName(?string $triggerName, ?int $leadId = null): bool

Очистить джобы по коду скрипта

bot.clearTriggerJobsByScriptCode(?string $scriptCode, ?int $leadId = null, ?int $ticketId = null): bool

Очистить джобы по  id триггера и ID заявки

bot.clearTriggerJobsByIdForTicket(?int $triggerId, ?int $ticketId): bool

Очистить джобы по наименованию триггера и ID заявки

bot.clearTriggerJobsByNameForTicket(?string $triggerName, ?int $ticketId): bool

Каждый из методов подробнее расписан ниже.

Планирование триггера

bot.scheduleTrigger(?int $triggerId, ?int $leadId, ?int $ticketId = null, $jobParams = [])
Описание:

Запускает триггер в соответствии с указанными параметрами.

Атрибуты:
Имя Тип Описание triggerId int ID триггера, который будет запущен leadId int ID лида, для которого будет запущен триггер ticketId int ID заявки, для которой будет запущен триггер jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение планирования триггера.

Пример:
var result = bot.scheduleTrigger(4213, 1426, null, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});

Планирование триггера по коду

bot.runTriggerByCodeForLead(?string $triggerCode, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

Запускает триггер в соответствии с указанными параметрами по коду.

Атрибуты:
Имя Тип Описание triggerCode string ID триггера, который будет запущен leadId int ID лида, для которого будет запущен триггер ticketId int ID заявки, для которой будет запущен триггер addToQueue bool Добавление в очередь триггеров jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение планирования триггера.

Пример:
var result = bot.runTriggerByCodeForLead('test', 1426, null, true, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});

Планирование триггера по коду для последнего лида персоны

bot.runTriggerByCodeForPerson(?string $triggerCode, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

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

Атрибуты:
Имя Тип Описание triggerCode string ID триггера, который будет запущен personId int ID персоны, для которой будет найден последний лид ticketId int ID заявки, для которой будет запущен триггер addToQueue bool Добавление в очередь триггеров jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение планирования триггера.

Пример:
var result = bot.runTriggerByCodeForPerson('test', 1426, null, true, {
  "is_periodic": true,
  "repeat_interval_sec": 10,
  "script_request_params": {
        "name": "Alex" 
  }
});

Удалить триггеры для лида

bot.clearTriggerJobsForLead(?int $leadId, ?int $ticketId = null)
Описание:

Удаляет все триггеры из очереди для лида.

Атрибуты:
Имя Тип Описание leadId int ID лида, триггеры которого будут удалены ticketId int ID заявки, триггеры которого будут удалены
Возвращает:

bool - подтверждение удаления триггеров.

Пример:
bot.clearTriggerJobsForLead(236178);

Удалить триггеры для всех лидов персоны

bot.clearTriggerJobsForAllPersonLeads(?int $personId, ?int $ticketId = null)
Описание:

Удаляет все триггеры из очереди для всех лидов персоны.

Атрибуты:
Имя Тип Описание personId int ID персоны, триггеры которой будут удалены ticketId int ID заявки, триггеры которого будут удалены
Возвращает:

bool - подтверждение удаления триггеров.

Пример:
bot.clearTriggerJobsForAllPersonLeads(36178);

Получить ID триггера по наименованию

bot.getTriggerIdByName(?string $triggerName)
Описание:

Возвращает id триггера по указанному наименованию.

Атрибуты:
Имя Тип Описание triggerName string Наименование триггера
Возвращает:

int - id триггера в формате числа.

Пример:
let TriggerId = bot.getTriggerIdByName('Триггер');

Получить ID Триггера по Коду

bot.getTriggerIdByCode(?string $triggerCode)
Описание:

Возвращает id триггера по указанному коду.

Атрибуты:
Имя Тип Описание triggerCode string Код триггера
Возвращает:

int - id триггера в формате числа.

Запустить триггер для лида по ID триггера

bot.runTriggerForLead(?int $triggerId, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

Запускает триггер для лида по указанному id триггера.

Атрибуты:
Имя Тип Описание triggerId int ID триггера, который будет запущен leadId int ID лида, для которого будет запущен скрипт ticketId int ID заявки, для которой будет запущен скрипт addToQueue bool Добавление в очередь скриптов jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение запуска триггера.

Пример:
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.runTriggerForLead(TriggerId, 236178, null, true{
  "run_at": "2021-03-23 19:01:00", 
});

Запустить триггер для лида по наименованию

bot.runTriggerByNameForLead(?string $triggerName, ?int $leadId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

Запускает триггер для лида по указанному имени триггера.

Атрибуты:
Имя Тип Описание triggerName string Наименование триггера, который будет запущен leadId int ID лида, для которого будет запущен скрипт ticketId int ID заявки, для которой будет запущен скрипт addToQueue bool Добавление в очередь скриптов jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение запуска триггера.

Пример:
bot.runTriggerByNameForLead('Триггер', 236178, null, true{
  "run_after_sec": 5, 
});

Запустить триггер для персоны по ID

bot.runTriggerForPerson(?int $triggerId, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

Запускает триггер для персоны по указанному id триггера.

Атрибуты:
Имя Тип Описание triggerId int ID триггера, который будет запущен personId int ID персоны, для которой будет запущен скрипт ticketId int ID заявки, для которой будет запущен скрипт addToQueue bool Добавление в очередь скриптов jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение запуска триггера.

Пример:
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.runTriggerForPerson(TriggerId, 36178, null, true);

Запустить триггер для персоны по наименованию

bot.runTriggerByNameForPerson(?string $triggerName, ?int $personId, ?int $ticketId = null, $addToQueue = true, $jobParams = [])
Описание:

Запускает триггер для персоны по указанному имени триггера.

Атрибуты:
Имя Тип Описание triggerName string Наименование триггера, который будет запущен personId int ID персоны, для которой будет запущен скрипт ticketId int ID заявки, для которой будет запущен скрипт addToQueue bool Добавление в очередь скриптов jobParams json

Передача в планируемую задачу входящих json параметров. Можно указать script_request_params (для скрипта/триггера/рассылки)
condition_script_code (для перекрытия условия триггера/рассылки).

Для установки времени запуска:

run_at - точное время запуска (по часовому поясу сервера)
или
run_after_sec - для запуска через указанное кол-во секунд

Если указать run_at и run_after_sec то будет использован только параметр run_at.

Возвращает:

bool - подтверждение запуска триггера.

Пример:
bot.runTriggerByNameForPerson('Триггер', 36178, null, true);

Очистить джобы по id триггера

bot.clearTriggerJobsById(?int $triggerId, ?int $leadId = null)
Описание:

Выполняется поиск и очистка джоб по id триггера.

Атрибуты:
Имя Тип Описание triggerId int ID триггера leadId int ID лида
Возвращает:

bool - подтверждение очистки джоб.

Пример:
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.clearTriggerJobsById(TriggerId);

Очистить джобы по наименованию триггера

bot.clearTriggerJobsByName(?string $triggerName, ?int $leadId = null)
Описание:

Выполняется поиск и очистка джоб по наименованию триггера.

Атрибуты:
Имя Тип Описание triggerName string Наименование триггера leadId int ID лида
Возвращает:

bool - подтверждение очистки джоб.

Пример:
bot.clearTriggerJobsByName('Триггер');

Очистить джобы по коду скрипта

bot.clearTriggerJobsByScriptCode(?string $scriptCode, ?int $leadId = null, ?int $ticketId = null)
Описание:

Выполняется поиск и очистка джоб триггеров по коду скрипта.

Атрибуты:
Имя Тип Описание scriptCode string Код скрипта leadId int ID лида ticketId int ID заявки
Возвращает:

bool - подтверждение очистки джоб.

Очистить джобы по id триггера и ID заявки

bot.clearTriggerJobsByIdForTicket(?int $triggerId, ?int $ticketId)
Описание:

Выполняется поиск и очистка джоб по id триггера и ID заявки.

Атрибуты:
Имя Тип Описание triggerId int ID триггера ticketId int ID заявки, джобы которой будут очищены
Возвращает:

bool - подтверждение очистки джоб.

Пример:
let TriggerId = bot.getTriggerIdByName('Триггер');
bot.clearTriggerJobsByIdForTicket(TriggerId, 17256);

Очистить джобы по наименованию триггера и ID заявки

bot.clearTriggerJobsByNameForTicket(?string $triggerName, ?int $ticketId)
Описание:

Выполняется поиск и очистка джоб по наименованию триггера и ID заявки.

Атрибуты:
Имя Тип Описание triggerName string Наименование триггера ticketId int ID заявки, джобы которой будут очищены
Возвращает:

bool - подтверждение очистки джоб.

Пример:
bot.clearTriggerJobsByNameForTicket('Триггер', 17256);