Skip to content
Документация для разработчиков Wavesend.ru
Войти

API-based Entry

Обзор и сценарии использования

Section titled “Обзор и сценарии использования”

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

Вот несколько сценариев использования API-based Entry:

  • Информировать клиентов о том, что некоторые из ваших товаров снова в наличии;
  • Сообщать пользователям о снижении цены на популярный товар;
  • Уведомлять подписчиков о выходе нового выпуска подкаста.

В отличие от обычных Events, все эти бизнес-события могут происходить вне приложения. Например, наличие товара можно проверить только во внешней базе данных. Именно здесь и пригодится API-based Entry: вы можете настроить отправку запроса на запуск Journey всякий раз, когда вне приложения (например, в вашей внешней базе данных) происходят определенные изменения.

Это работает следующим образом:

  1. Создайте Journey с API-based Entry. В настройках входа вы найдете шаблон запроса, который запускает Journey.
  2. Добавьте в запрос условия сегментации, используя язык сегментации. Вы также можете добавить в запрос плейсхолдеры для изменения содержимого сообщения в зависимости от контекста.
  3. При необходимости автоматизируйте запрос. Например, информация об изменении цены может быть немедленно отправлена из базы данных в Webhook. Как только это произойдет, Webhook должен автоматически отправить запрос на запуск Journey. Вы также можете отправить запрос вручную, если автоматизация не требуется.

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

Для получения более подробной информации следуйте приведенным ниже инструкциям.

Настройка

Section titled “Настройка”
  1. Создайте Journey с API-based Entry:

  1. Дважды щелкните по шагу API-based Entry. Откроется окно настройки элемента.

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

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

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

Теперь создайте Preset для Push или Email-сообщения [/product/content/push-presets] и вставьте плейсхолдер вместо текста, который вы хотите изменять. Плейсхолдер должен быть в одном из следующих форматов в зависимости от ваших потребностей:

  • {placeholder_name|format_modifier|} – если значение плейсхолдера не указано при запуске кампании, пользователи увидят на его месте пустое место.
  • {placeholder_name|format_modifier} – если значение плейсхолдера не указано и еще не было присвоено пользователю (в случае, если вы использовали Tag в качестве плейсхолдера), сообщение отправлено не будет.
Модификаторы формата
  • CapitalizeFirst – делает заглавной первую букву в значении плейсхолдера;
  • CapitalizeAllFirst – делает заглавными первые буквы всех слов в значении плейсхолдера, если значение состоит из нескольких слов;
  • UPPERCASE – переводит все буквы в верхний регистр;
  • lowercase – переводит все буквы в нижний регистр;
  • regular – вставляет значение плейсхолдера точно так, как оно указано в запросе, без изменений.

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

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

  1. В окне настройки входа скопируйте шаблон запроса для его изменения:
  1. Добавьте фильтры аудитории в параметр “filter”, используя язык сегментации или скопируйте язык сегментации из созданных вами ранее Segment. Обратите внимание, что вам необходимо заранее настроить нужные Tags.

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

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

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

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

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

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

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