Pruvodce - API

Použití webhook pro odeslání pozvánky stávajícímu respondentovi

Pozvánku k průzkumu můžete zaslat na uvedenou e-mailovou adresu, která je již v systému vedena, případně na ni již byla pozvánka odeslána. Toho je možné dosáhnout 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říkladová URL

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

Kde:

  • id_account – token respondenta, kterému chceme poslat pozvánku.
  • 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-to-token
  • 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:
    • 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
    • token – token respondenta, kterému chceme poslat pozvánku.
    • 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říkladová URL s dodatečnými parametry odeslanými metodou GET:

https://www.netquest.cz/webhooks/387487/TUwNjNDg3M/84b750d6956f02503015938fc38bfe36/send-invitation-to-token?id_survey=419349&id_template=1833&token=81a2B7&delay=15&footer=0

Výše uvedený webhook pošle pozvánku na token s ID = 81a2B7 . 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":"Respondents not found"}

Je-li vyčerpán limit možných pozvánek, webhook vrátí následující chybu:

{"type":"error","msg":"Invitations limit has been reached"}

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

Na co pamatovat?

  • Pro získání hodnot parametrů: id_account, id_survey, id_template nás prosím kontaktujte.

Pomohl Vám tento článek?

Děkujeme za odpověď