Wszystkie kolekcje
API dokumentacja
Webhooki
Webhook dodający respondenta do bazy odbiorców
Webhook dodający respondenta do bazy odbiorców
Artur Zbiejcik avatar
Napisane przez Artur Zbiejcik
Zaktualizowano ponad tydzień temu

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.

  • 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 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 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 zostanie dodany respondent. (Jest numer ID ankiety z zakładki PROJEKTY). Parametr obowiązkowy

Przykładowa postać URL-a z dodatkowymi parametrami wysyłanymi jako GET to:

https://www.webankieta.pl/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/add-respondent?id_survey=399793&[email protected]&l1=Jan&l2=Kowalski&l3=Prezes&l4=VIP&l5=601602603

Powyższy Webhook doda respondenta o adresie [email protected] do ankiety od ID = 399793. Respondenta zostanie opisany również wartościami atrybutów: Jan, Kowalski, Prezes, VIP, 601602603.

W tym przykładzie atrybuty stworzone w ankiecie to: Imię, Nazwisko, Stanowisko, Segment, nr telefonu.

{
"type":"success",
"msg":"Respondent has been saved on the survey's mailing list",
"data":
{"id_respondent":52909566,"token":"96BD97"}
}

Czy to odpowiedziało na twoje pytanie?