View Source

Webhook — механизм получения уведомлений при поступлении анкет.

Настроить Webhook можно при создании как классического проекта, так и с точками опроса на первом Шаге создания.

База знаний SimpleForms > Проекты. Webhook при поступлении анкет > webhook-01.png

При настройке необходимо указать URL и параметры. Также можно настроить Лог на почту. Если указать e-mail каждый день будет приходить лог за прошедшие сутки.

Внести изменения в Webhook можно и в настройках проекта, когда проект уже отправлен в работу.
База знаний SimpleForms > Проекты. Webhook при поступлении анкет > webhook-02.png

Общая схема

При получении анкеты на сайт, происходит отправка GET запроса на заданный URL c указанными параметрами.
Каждая отправка GET запроса на заданный URL записывается в лог, который хранится сутки и отправляется на заданный e-mail или удаляется.

Задание параметров URL

в каждом запросе будут переданы следующие служебные параметры:

Имя параметра	Значение
SF_Result	0 - Завершающий в скрининге, 1 - Целевая анкета, 2 - Не подходит по квотам
SF_ID	GUID анкеты

так же, если в указанном URL есть какие-то параметры, то они ретраслируются дальше. (условно: www.ya.ru/?APIKEY="ABCDEFG" - так же передается дальше)
дополнительно URL может быть дополнен параметрами, схема задания: ID вопроса через запятую, пробелы игнорируются, например: Q1, Q2, Q34
если получен код вопроса, которого нет в анкете (или неподдерживаемый тип) - этот параметр игнорируется и не передается
поддерживаемые типы вопросов:

Тип вопроса	Возвращается	Комментарии
Текст	значение открытого вопроса	запрещеннные символы в ответе #, &, =
Диапазон	код ответа
Число	значение
Выбор вариантов, уточняющий	коды ответов через запятую без пробелов, значение "другое" - не передается, только коды
Ранг	не передается
Сетка	не передается
Дата	дату
Шкала	значение шкалы

Пример:

База знаний SimpleForms > Проекты. Webhook при поступлении анкет > image2017-8-9_10-30-47.png

где arg="Проект SimpleForms" - произвольные аргументы, которые будут переданы как есть
Q1,Q2,Q3 - коды вопросов, будут переданы их значения
user@example.com - почта, на которую будет отправлен Лог.

На почту будет отправлено сообщение с текстовым файлом (логом), в котором будет содержаться информация о выполнении Webhook.

Пример одной строки:

При обработке анкеты #24, идентификатор '439b8ed6-61fe-4cd4-871c-8g25dfd91cfe' произведена загрузка страницы 'https://example.com/exec?arg="Проект SimpleForms"&Q1=1&Q2=2&Q3=3&SF_ID=439b8ed6-61fe-4cd4-871c-8g25dfd91cfe&SF_Result=1'.