Pruvodce - API

Použití webhook pro aktualizaci doplňujících informací (štítků) respondenta v databázi příjemců

Aktualizovat doplňující informace (štítky) respondenta v databázi příjemců, je možné voláním tzv. webhook metody. Webhook není nic jiného než URL adresa, která se zavolá pomocí jiného informačního systému nebo je otevřena v běžném prohlížeči.

Příkladová URL

https://www.netquest.cz/webhooks/[id_account]/[webhook_key]/[webhook_auth]/[webhook_name]?dodatecne_parametry

Kde:

  • id_account – ID Vašeho účtu na platformě Netquest. Pro získání této informace nás prosím kontaktujte.
  • webhook_key a webhook_auth – klíč a autorizace webhooku. Parametry jsou dostupné po přihlášení v účtu uživatele v záložce Nastavení účtu -> Nastavení -> Integrace. Po vygenerování klíčů získáte tyto hodnoty.
  • webhook_name – v tomto případě, update-respondent
  • dodatecne_parametry – dodatečné parametry určující respondenta. Dodatečné parametry mohou být vloženy metodami GET nebo POST. Tyto jsou:
    • id_respondent – ID příjemce mailingu (příjemce pozvánky)
    • l1, l2, …., l15 – dodatečné štítky kontaktu. Štítky musí být předdefinované pro dotazník na který je pozvánka odeslána. Všechny parametry jsou nepovinné.
    • id_survey – ID dotazníku do kterého má být respondent přidán (pro získání hodnoty nás kontaktujte). Povinný parametr

Příkladová URL s dodatečnými parametry odeslanými metodou GET:

https://www.netquest.cz/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/update-respondent?id_survey=399793&id_respondent=12345&l4=SuperVIP&l7=9

Výše uvedený webhook aktualizuje informace respondenta s ID = 12345 v dotazníku ID = 399793. Respondent získá nové hodnoty štítků l4 a l7.

Příkladová odpověď serveru

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

Na co pamatovat?

  • Pro získání hodnot parametrů id_account a id_survey nás prosím kontaktujte.
  • Chcete-li získat hodnotu parametru id_respondent, můžete použít makro [ID_RESPONDENT]

Pomohl Vám tento článek?

Děkujeme za odpověď