Перейти к содержанию
Документация для разработчиковПоддержка Запросить демо Войти
Pushwoosh.com

Вход в Journey по API

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

Вот несколько примеров использования входа по API:

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

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

Элемент входа по API на холсте Journey

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

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

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

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

Настройка Journey с входом по API

Anchor link to
  1. Создайте Journey с входом по API:

  1. Дважды щелкните по шагу входа по API. Откроется окно конфигурации входа.

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

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

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

Добавление имен плейсхолдеров в окне настройки входа по API

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

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

При настройке элемента Push или Email в вашем Journey выберите созданный пресет и включите опцию Персонализировать сообщение с помощью атрибутов события.

Выберите плейсхолдеры, которые вы хотите изменять в запросе при запуске Journey. В качестве источника выберите API-based entry entry, а в качестве динамического атрибута — имя плейсхолдера:

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

  1. В окне конфигурации входа скопируйте шаблон запроса для его изменения:
Копирование шаблона запроса из окна конфигурации входа по API
  1. Добавьте фильтры аудитории в параметр "filter", используя язык сегментации или скопируйте логику сегментации из ваших сегментов. Заранее настройте необходимые Tags.

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

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

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

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

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

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

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