Průvodce - API

Použití webhook pro přidání respondenta do databáze příjemců

Přidání respondenta do databáze příjemců, bez nutnosti odeslání pozvánky, 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]?id_survey=123456&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ě, add-respondent
  • dodatecne_parametry – dodatečné parametry určující respondenta. Dodatečné parametry mohou být vloženy metodami GET nebo POST. 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 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/send-invitation?id_survey=399793&email=martin.novak@netquest.cz&l1=Martin&l2=Novak&l3=CEO&l4=VIP&l5=775123456

Výše uvedený webhook přidá respondenta s adresou martin.novak@netquest.cz do průzkumu s ID = 399793. Respondent bude uveden s hodnotami: Martin, Novák, CEO, VIP, 775123456. V tomto příkladu jsou štítky respondenta: Jméno, Příjmení, Funkce, Segment, a Telefonní číslo.

Na co pamatovat?

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

Pomohl Vám tento článek?

Děkujeme za odpověď