Przejdź do głównej zawartości
Wszystkie kolekcjeAPI dokumentacjaWebhooki
Webhook do wysyłki zaproszenia do istniejącego respondenta
Webhook do wysyłki zaproszenia do istniejącego respondenta
Artur Zbiejcik avatar
Napisane przez Artur Zbiejcik
Zaktualizowano ponad rok temu

Istnieje możliwość wysłania zaproszenia do wypełnienia ankiety na wskazany adres e-mail, do którego już wcześniej wysyłaliśmy zaproszenie. Jest to możliwe 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]/send-invitation-to-token?dodatkowe_parametry

Dodatkowe parametry to:

  • token – token respondenta, do którego chcemy wysłać zaproszenie.

  • 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 - 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/171257/MjU3ABUyMj/3a12307689817111c82711d910f5f4aa/send-invitation-to-token?id_survey=419349&id_template=3593&token=81a2B7

Ważne!
W przypadku gdy na koncie zostaną wyczerpane limity wysyłek zaproszeń, webhook zwróci błąd

{„type”:”error”,”msg”:”Invitations limit has been reached”}

Jeżeli kod dostępu (token) został wcześniej usunięty z ankiety lub jest nie prawidłowy to webhook zwróci błąd („token not found”)

Pamiętaj!

Aby uzyskać wartość parametru: id_template, zapraszamy do kontaktu pod adresem [email protected]

Czy to odpowiedziało na twoje pytanie?