Poradnik - Dokumentacja API

Webhook aktualizujący dane respondenta w bazie odbiorców

Istnieje możliwość aktualizacji danych respondenta w bazie obiorców w celach ponownych wysyłek. 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 update-respondent
  • dodatkowe_parametry – dodatkowe parametry określające respondenta. Dodatkowe parametry mogą być wysyłane jako parametry GET lub jako parametry POST. Są to:
    • id_respondent – id respondenta adresata z listy wysyłkowej
    • l1, l2, …., l10 – dodatkowe etykiety pola kontaktu. 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/update-respondent?id_survey=399793&id_respondent=12345&l4=SuperVIP&l7=9

Powyższy Webhook zaktualizuje dane respondenta o ID 12345 w ankiecie od ID = 399793. Respondent zyska nowe wartościami etykiet: l4 = SuperVIP i l7 = 9 (przykładowa wartość pytania NPS).

Przykładowa odpowiedź serwera:

{"type":"success","msg":"Respondent has been updated on the survey's mailing list"}

Pamiętaj!

  • Aby uzyskać wartości parametrów: id_account, id_survey, zapraszamy do kontaktu pod adresem kontakt@webankieta.pl
  • Aby uzyskać wartość parametru id_respodnent, możesz posłużyć się makrem [ID_RESPONDENT]

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi