Poradnik - Dokumentacja API

Webhook dodający respondenta do bazy odbiorców

Istnieje możliwość dodania respondenta do bazy obiorców zaproszenia do ankiety bez wysłania zaproszenia. 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 add-respondent
  • dodatkowe_parametry – dodatkowe parametry określające respondenta. 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 zostanie dodany respondent (skontaktuj się z nami w celu uzyskania wartości parametru). Parametr obowiązkowy

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

Powyższy Webhook doda respondenta o adresie j.kowalski@webankieta.pl do ankiety od ID = 399793. Respondenta zostanie opisany również wartościami etykiet: Jan, Kowalski, Prezes, VIP, 601602603. W tym przykładzie etykiety stworzone w ankiecie to: Imię, Nazwisko, Stanowisko, Segment, nr telefonu.

Pamiętaj!

Aby uzyskać wartości parametrów: id_account, id_survey, zapraszamy do kontaktu pod adresem kontakt@webankieta.pl

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi