Все коллекции
Onboarding.Online FAQ
Web2App Онбординги
Как отправить данные в ваш WebHook
Как отправить данные в ваш WebHook
В
Автор: Валерия Зимницкая
Обновлено больше недели назад

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

Как передать параметры из ссылки Web2App онбординга в вебхук

Если ваша ссылка Web2App онбординга содержит параметры (например, атрибуты рекламной кампании), вы можете передать их в вебхук на вашем сервере(как настроить вебхук читайте в статье). Например, вы создали ссылку: https://web.onboarding.online/welcome-to-books-app и добавили к ней параметры атрибуции: https://web.onboarding.online/welcome-to-books-app?utm_source=facebook&utm_medium=cpc&utm_campaign=audience_FB&utm_content=Books_App.


Следуйте инструкции ниже, чтобы добавить параметры в вебхук:

Шаг 1: Перехват параметра

Откройте экран редактирования Web2App ссылки и нажмите "+ADD" в разделе "Income parameters".

Вы увидите экран для добавления перехвата GET параметра.

  • В поле 'Get Parameter Name' введите имя параметра из вашей начальной ссылки (например, utm_source). Оно должно точно совпадать.

  • В поле 'Income parameter key' введите название параметра, которое будет сохранено для передачи . Вы можете переименовать полученный параметр или оставить название без изменений. Например, utm_source или HELLO.

  • Укажите тип параметра ('parameter type') - тип данных в параметре (строка или число)

Сохраните перехват параметра, нажав на ADD

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

После того, как вы добавили перехват параметра, его нужно добавить в вебхук реквест по шагам ниже:

Шаг 2: Добавление параметра в реквест вебхука

Добавьте и настройте вебхук. В секции "request parameters" нажмите "ADD".

Вы увидите экран для добавления параметра в вебхук. Заполните поля на экране:

  • Укажите способ перехвата - выберите "Income parameter" из выпадающего списка.

  • Введите ‘Value’, оно должно соответствовать имени параметра, которое вы ввели в "Income parameter key" (например, HELLO или utm_source).

  • Введите "Key" — названием параметра в реквесте вебхука. Например, если вы напишете BUY, ваш вебхук будет содержать параметр BUY со значением из utm_source.

Сохраните добавление параметра в вебхук, нажав на ADD

Чтобы применить добавление параметра в вебхук нажмите Update

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

Пример

Вы добавили перехват параметра 'utm_source' под именем 'HELLO'. Затем добавили отправку параметра в вебхук, указав 'HELLO' как 'Value' и 'BYE' как 'Key'. В итоге получится: https://yourserver.com/webhook?BYE=facebook.

Как отправить Amplitude ID, IP, and UserAgent в Webhook

Настройте Web2App ссылку, выбрав нужные параметры.: Amplitude ID, IP или UserAgent.

Добавьте вебхук и в секции "request parameters" нажмите "ADD"

Появится экран для добавления реквест параметра в в вебхук. Заполните поля:

  • Укажите способ перехвата - выберите "Income parameter" из выпадающего списка.

  • Значение поля ‘Value’ должно соответствовать названию параметра, которое было добавлено в "Income parameter key" : userIp, userAgent, или amplitudeDeviceId

    Для удобства вы можете скопировать название из секции Income parameters

  • В пол "Key" введите имя параметра для вебхука. Например, если вы хотите передать UserIp и назвать параметр 'USER_IP' - введите в 'Key' USER_IP -> параметр с названием USER_IP будет отправлен в вебхук.

Сохраните добавление параметра в вебхук, нажав на ADD

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

Пример

Вы добавили 'userIp' как 'Value' и 'USER_IP' как 'Key'. Результат: https://yourserver.com/webhook?USER_IP=[полученный user ip].

Важно: Чтобы отправить amplitudeDeviceId, нужно добавить эту систему аналитики в настройках проекта в нашем сервисе - инструкция ссылке

Как передать данные, введенные пользователем, в WebHook

Чтобы передать данные с определенного экрана (например, введенный пользователем адрес электронной почты, выбор в таблицах и т.д.), следуйте этим шагам:

Запомните ScreenID, с которого хотите отправить данные.

В форме редактирования Web2App ссылки добавьте вебхук, в разделе "request parameters" нажмите +ADD

Появится экран для добавления параметра в реквест вебхука. Заполнить поля:

  • Укажите способ перехвата - выберите "User data" из выпадающего списка.

  • В поле "Value" введите Screen ID, который зафиксировали выше.

  • В поле "Key" введите название, которые вы хотите присвоить параметру в вебхуке. Например, если вы введете ‘email’ то в вебхук добавится параметр с названием = email и значением, содержащим емейл введенный пользователем

Нажмите на кнопку ADD, чтобы добавить параметр

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

Нажмите Update, чтобы параметр применился

Пример

Вы отправили данные со screen1, где пользователь ввел емейл, используя 'email' как 'Key'. Результат: https://yourserver.com/webhook?UserEmail=[user@user.com].

Как передать данные из одного вебхука в другой

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

Шаг 1: Перехват ответа вебхука

Настройте тип вебхука "WaitForResponse". В разделе "Response parameters" нажмите "+ADD"

  • В поле 'Key' введите точное название параметра, который придет в ответе вашего сервера.

  • Выберите тип данных, который присылает ваш сервер в этом параметре (string, int, or double)

Нажмите ADD

Шаг 2: Отправка полученного параметра в следующий вебхук

Добавьте ещё один вебхук. В разделе "request parameters" нажмите "+ADD"

  • В выпадающем списке выберите тип перехвата "Hook Response."

  • В поле "Value" введите точное названием параметра, который приходит в ответе предыдущего вебхука.

  • В поле "Key" введите параметра, который отправится реквест текущего вебхука.

Нажмите Update, чтобы параметр применился

Пример

Вы настроили вебхук для перехвата 'UserID' и добавили второй вебхук с URL https://yourserver.com/webhook2, указав 'UserID' как 'Value' и 'UniqueUserID' как 'Key'. Результат: https://yourserver.com/webhook2?UniqueUserID=[значение из вебхука1].

Нашли ответ на свой вопрос?