Poradnik - Dokumentacja API

Webhook do wysyłki zaproszenia do wypełnienia ankiety

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. Aby je poznać zapraszamy do kontaktu
  • webhook_keywebhook_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. Są to:
    • email – adres e-mail adresata (odbiorcy zaproszenia)
    • l1, l2, …., l10 – dodatkowe etykiety pola kontaktu. Etykiety 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 (skontaktuj się z nami w celu uzyskania wartości parametru). Parametr obowiązkowy
    • id_template – ID szablonu wysyłanego zaproszenia (skontaktuj się z nami w celu uzyskania wartości parametru). 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

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=j.kowalski@webankieta.pl&l1=Jan&l2=Kowalski&l3=Prezes&l4=VIP&l5=601602603&delay=15&footer=0

Powyższy Webhook wyśle zaproszenie na adres j.kowalski@webankieta.pl. Jeżeli w treści szablonu zaproszenia (o id_template = 1833) znajdą się makra wykorzystujące etykiety 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ści parametrów: id_account, id_survey, id_template, zapraszamy do kontaktu pod adresem kontakt@webankieta.pl

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi