Istnieje możliwość wysłania zaproszenia do wypełnienia ankiety na wskazany adres e-mail, poprzez wywołanie tzw. Webhooka. Webhook to nic innego jak URL wywoływany za pomocą innego systemu informatycznego lub otwierany w zwykłej przeglądarce.
Postać adresu URL jest następująca:
https://www.webankieta.pl/webhooks/[id_account]/[webhook_key]/[webhook_auth]/[webhook_name]?dodatkowe_parametry
Gdzie:
id_account – ID Twojego konta na platformie Webankieta.
webhook_key i webhook_auth – klucz i autoryzacja Webhooka. Parametry dostępne po zalogowaniu na konto użytkownika w zakłądce Konto -> Ustawienia -> Integracje. Po wygenerowaniu kluczy otrzymasz ich wartości.
webhook_name – w tym przypadku to send-invitation
dodatkowe_parametry – dodatkowe parametry określające adresata wiadomości i termin wysyłki zaproszenia. Dodatkowe parametry mogą być wysyłane jako parametry GET lub jako parametry POST.
Dodatkowe parametry:
email – adres e-mail adresata (odbiorcy zaproszenia)
l1, l2, …., l10 – dodatkowe atrybuty pola kontaktu. Atrybuty muszą być wcześniej zdefiniowane dla ankiety, do której zaproszenie jest wysyłane. Wszystkie parametry są opcjonalne.
id_survey – ID ankiety, do której zaproszenie jest wysyłane (Jest to ID ankiety z zakładki PROJEKTY). Parametr obowiązkowy
id_template – ID szablonu wysyłanego zaproszenia (aby dowiedzieć się jak pobrać ID_template kliknij TUTAJ ). Parametr obowiązkowy
delay – opóźnienie wysyłki zaproszenia w minutach. Parametr opcjonalny.
footer – możliwość wyłączenia stopki z informacją o nadawcy. Domyślnie stopka jest włączona.
reminder_delay - liczba godzin od wysyłki, po której ma zostać wysłane przypomnienie dla respondentów, którzy nie wypełnili ankiety. Gdy parametr nie jest ustawiony przypomnienie nie zostanie wysłane.
Przykładowa postać URL-a z dodatkowymi parametrami wysyłanymi jako GET to:
https://www.webankieta.pl/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/send-invitation?id_survey=399793&id_template=1833&[email protected]&l1=Jan&l2=Kowalski&l3=Prezes&l4=VIP&l5=601602603&delay=15&footer=0
Powyższy Webhook wyśle zaproszenie na adres [email protected]. Jeżeli w treści szablonu zaproszenia (o id_template = 1833) znajdą się makra wykorzystujące atrybuty respondenta, pojawią się w jego treści. Zaproszenie zostanie wysłane 15 minut po tym jak został wykonany webhook.
Ważne!
W przypadku gdy wysyłka będzie odbywać się do respondenta, który zrezygnował z otrzymania zaproszeń do ankiet, webhook zwróci błąd:
{„type”:”error”,”msg”:”Respondents not found”}
W przypadku gdy na koncie zostaną wyczerpane limity wysyłek zaproszeń, webhook zwróci błąd
{„type”:”error”,”msg”:”Invitations limit has been reached”}
Zaproszenie zostanie wysłane zgodnie z ustawieniami serwera pocztowego na koncie użytkownika.
Pamiętaj!
Aby uzyskać wartość parametru: id_template, zapraszamy do kontaktu pod adresem [email protected]