Průvodce - API

Použití webhook pro rozesílání pozvánek k průzkumu

Pozvánku k průzkumu můžete zaslat na uvedenou e-mailovou adresu voláním tzv. webhook metody. Webhook není nic jiného než URL, která se zavolá pomocí jiného informačního systému nebo je otevřena v běžném prohlížeči.

Příklad URL je následující:

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ě, send-invitation
  • dodatecne_parametry – dodatečné parametry určující příjemce a datum odeslání pozvánky. Dodatečné parametry mohou být použity jako GET parametry nebo jako POST parametry. Tyto jsou:
    • email – e-mailová adresa příjemce (příjemce pozvánky)
    • l1, l2, …., l10 – 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 na který je pozvánka odeslána (pro získání hodnoty nás kontaktujte). Povinný parametr
    • id_template – ID šablony pro odeslání pozvánky (pro získání hodnoty nás kontaktujte). Povinný parametr
    • delay – prodleva v odeslání pozvánky v minutách. Nepovinný parametr
    • footer – možnost vypnutí zápati s informací o odesílateli. Ve výchozím nastavení zapnuto

Příklad adresy URL s dodatečnými parametry odeslanými jako GET:

https://www.netquest.cz/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/send-invitation?id_survey=399793&id_template=1833&email=martin.novak@netquest.cz&l1=Martin&l2=Novak&l3=CEO&l4=VIP&l5=601602603&delay=15&footer=0

Výše uvedený Webhook pošle pozvánku na martin.novak@netquest.cz. Pokud v obsahu šablony pozvánky (id_template = 1833) existují makra, která používají štítky respondenta, objeví se ve svém obsahu. Pozvánka bude zaslána 15 minut po vytvoření webhooku.

Důležité!
V případě, že bude pozvánka odeslána respondentovi, který se odhlásil z přijímání pozvánek do průzkumů, vrátí webhook následující chybu: {„type“: „error“, „msg“: „Respondenti nebyli nalezeni“}

Pozvánka bude odeslána podle nastavení poštovního serveru účtu uživatele.

Prosíme pamatujte!
Chcete-li získat hodnoty parametrů: id_account, id_survey, id_template, kontaktujte nás na help@netquest.cz

Pomohl Vám tento článek?

Děkujeme za odpověď