Запуск сценариев с помощью входа по API

Вход по API позволяет запускать сценарий в момент, когда происходит определенное бизнес-событие. Чтобы запустить кампанию, необходимо отправить специальный API-запрос.

1. Создайте сценарий с элементом “Вход по API”.

2. Дважды щелкните по шагу “Вход по API”. Откроется окно настройки входа.

3. Вы можете изменять содержимое push-уведомлений и email-сообщений при каждом запуске сценария с помощью плейсхолдеров. Значение каждого плейсхолдера можно изменить в запросе. Если вам не нужна эта опция, можете пропустить этот шаг.

Например, вы создаете сценарий для уведомления подписчиков о выходе нового выпуска подкаста. С помощью плейсхолдера вы можете изменять название подкаста при каждом запуске сценария.

Сначала добавьте имена плейсхолдеров в окне настройки “Входа по API”. Вы можете использовать любые удобные для вас имена.

Теперь создайте пресет для push-уведомления или email-сообщения и вставьте плейсхолдер вместо текста, который вы хотите изменять. Плейсхолдер должен иметь один из следующих форматов в зависимости от ваших потребностей:

• {placeholder_name|format_modifier|} – если значение плейсхолдера не указано при запуске кампании, пользователи увидят на его месте пустое пространство.
• {placeholder_name|format_modifier} – если значение плейсхолдера не указано и еще не было присвоено пользователю (в случае, если вы использовали тег в качестве плейсхолдера), сообщение не будет отправлено.

При настройке шага “Push” или “Email” в вашем сценарии выберите созданный пресет и включите опцию Персонализировать сообщение с помощью атрибутов события. Выберите плейсхолдеры, которые вы хотите изменять в запросе при запуске сценария. В качестве источника выберите Вход по API, а в качестве динамического атрибута — имя плейсхолдера:

Нажмите Применить, чтобы сохранить изменения.

4. В окне настройки входа скопируйте шаблон запроса для его изменения:

5. Добавьте фильтры аудитории в параметр “filter”, используя Язык сегментации. Обратите внимание, что вам необходимо заранее настроить нужные теги.

Например, если вы хотите нацелить сценарий на пользователей, которые добавили товар Socks в свой Wishlist, значение “filter” должно выглядеть следующим образом:

"filter": "A(\"12345-12345\") * "T(\"Wishlist\", EQ, \"Socks\")"

В этом примере у вас должен быть настроен тег Wishlist в вашем приложении.

6. Если вы настроили плейсхолдеры, укажите желаемое содержимое в качестве их значений:

7. Если включена опция Ограничения скорости сообщений, количество пользователей, входящих в сценарий одновременно в секунду, будет ограничено. Вы можете использовать значение по умолчанию — 5000 пользователей в секунду — или установить другое число.

8. Если вы планируете часто перезапускать кампанию и не хотите, чтобы одни и те же пользователи входили в сценарий несколько раз, установите Ограничение частоты.

Например, вы создали кампанию для уведомления пользователей о снижении цены на определенный товар. Вы хотите перезапустить сценарий несколько раз, отправив несколько запросов с разными фильтрами аудитории. В этом случае вы можете добавить Ограничение частоты, чтобы уведомление не отправлялось повторно пользователям, которые соответствуют нескольким фильтрам.

9. Если вы хотите, чтобы сценарий запускался каждый раз, когда происходит определенное бизнес-событие, автоматизируйте запрос с помощью веб-хука. Как только событие произойдет, веб-хук должен автоматически отправить запрос на запуск сценария.

Вы также можете отправлять запрос вручную, если автоматизация не требуется.