В этой статье вы поймете, как настроить вебхуки для взаимодействия с вашим сервером для Web2App онбординга. Вебхуки могут отправлять запросы с любого экрана, принимать параметры, получать и сохранять ответы, а также передавать данные вебхука в редирект URL или в другой вебхук.
Чтобы Добавить вебхук откройте форму редактирования web2App ссылки.
В разделе Вебхуки нажмите +ADD
Далее вам нужно настроить вебхук по инструкции ниже:
Выберите тип вебхука:
Screen Leave: Срабатывает в момент, когда пользователь переходит с одного экрана на другой. Вы можете указать конкретный экран или установить его для каждого экрана.
Onboarding Finish: отправляется, когда пользователь завершает весь онбординг и уходит с последнего экрана
Wait for Response: работает только на экранах Slider или Progress bar для получения данных с вашего сервера и их использования в редирект ссылке. Именно тип может собирать ответы вебхука.
Выберите тип запроса на сервер Get или Post.
Введите URL запроса на ваш сервер.
Установите флаг "Отправить данные пользователя"('Send User Data'):
True: Автоматически отправляет все собранные данные пользователя в запросе вебхука.
False: Данные пользователя не отправляются автоматически, но вы можете указать и включить отправку данных с конкретных экранов в запросе вебхука(по инструкции ниже).
Пример использования флага 'send user data'
Пример использования флага 'send user data'
Представьте, у вас есть Web2App онбординг в приложение , где пользователи выбирают свои любимые жанры книг на разных экранах:
Экран 1: Пользователь выбирает свои любимые жанры
Экран 2: Пользователь выбирает любимых авторов.
Экран 3: Пользователь вводит свой емейл
Вы создали выебух, который отправляется после завершения онбординг.
Если вы поставите Отправить Данные Пользователя ('send user data') = True:
Вебхук автоматически включит все собранные данные пользователя с Экрана 1 и Экрана 2, Экрана3 в параметры запроса.
Запрос вебхука, отправленный в конце онбординга будет выглядеть так: https://yourserver.com/Webhook?screen1=Fantasy,Mystery&screen2=Orwell&screen3=email@email.com
Если вы поставите Отправить Данные Пользователя ('send user data') = false:
Если вы не указали экраны, с которых хотите собирать данные и не настроили отправку данных параметры вебхука - данные введенные пользователем не будут отправляться в вебхук.
Если вы указали конкретный экран и настроили отправку по инструкции ниже - данные собранные с него будут отправляться в вебхук.
Предположим, вы хотите отправить только выбор пользователя с Экрана 2. Вебхук будет выглядеть так:
Выберите Экран для Вызова Вебхука
Настройки экранов для вызова вебхука варьируется для каждого типа вебхука.
ScreenLeave: включите флажок и выберите конкретный экран. Если флажок отключен - вебхук будет отправляться как только пользователь уходит с каждого экрана
Onboarding Finish: Отправляется после последнего экрана только (выбор экранов не влияет на работу вебхука этого типа).
Wait for Response: Вы можете выбрать ID экрана Slider или Progress bar.
Настройте Webhook Headers (если нужно)
При необходимости добавить заголовки (например, Authorization, Content-Type и т.д). Для этого нажмите на кнопку Add в разделе headers в настройках ВебХука.
Добавьте ключ и значение заголовка. Сохраните заголовок, нажав ADD
Добавьте Параметры Запроса Вебхука
Вы можете отправить конкретные данные на ваш сервер, например, ввод пользователя, ID Amplitude и т.д. Подробные инструкции о том, как добавить параметры запроса, см. в статье.
Перехват Параметров Ответа Вебхука (только для типа 'Wait for Response' )
Если вы хотите использовать данные, полученный сервером далее (например, чтобы отправить их в Redirect URL или в другой WebHook для сегментации или атрибуции), нужно настроить перехват параметра ответа вебхука.
Важно перед настройкой захвата параметров ответа:
Убедитесь что вы выбрали тип 'Wait for Response' в настройке вашего вебхука - только этот тип ожидает ответ сервера и сохраняет параметры для последующей передачи.
Настройте поля вебхука по инструкции выше, включая URL вебхука, тип запроса, headers и тд.
Затем нажмите "+ADD" в разделе Response parameters вебхука.
В окне добавления вебхука заполните поля:
В поле 'Key' ведите точное имя параметра, который вы ожидаете получить от ответа вебхука
Выберите тип параметра (строка, целое число или дробное число) в зависимости от ожидаемого формата данных.
Нажмите кнопку ADD чтобы добавить перехват параметра ответа.
Далее вы можете использовать этот параметр для передачи его в редирект URL или другой вебхук