Sprievodca - API

Použitie webhook pre rozosielanie pozvánok na prieskum

Pozvánku na prieskum môžete zaslať na uvedenú e-mailovú adresu použitím tzv. Webhook metódy. Webhook nie je nič iné ako URL, ktorá sa vyvolá pomocou iného informačného systému alebo je otvorená v bežnom prehliadači.

Príkladová URL

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

Kde:

  • id_account – ID Vášho účtu na platforme Netquest. Pre získanie tejto informácie nás prosím kontaktujte.
  • webhook_key a webhook_auth – kľúč a autorizácie webhooku. Parametre sú dostupné po prihlásení v účte užívateľa v záložke Nastavenie účtu -> Nastavenia -> Integrácia. Po vygenerovaní kľúčov získate tieto hodnoty.
  • webhook_name – v tomto prípade, send-invitation
  • dodatecne_parametry – dodatočné parametre určujúce príjemcu a dátum odoslania pozvánky. Dodatočné parametre môžu byť použité ako GET parametre alebo ako POST parametre. Tieto sú:
    • email – e-mailová adresa príjemcu (príjemcu pozvánky)
    • l1, l2, …., l10 – dodatočné štítky kontaktu. Štítky musia byť preddefinované pre dotazník na ktorý je pozvánka odoslaná. Všetky parametre sú nepovinné.
    • id_survey – ID dotazníka na ktorý je pozvánka odoslaná (pre získanie hodnoty nás kontaktujte). povinný parameter
    • id_template – ID šablóny pre odoslanie pozvánky (pre získanie hodnoty nás kontaktujte). povinný parameter
    • delay – oneskorenie v odoslaní pozvánky v minútach. nepovinný parameter
    • footer – možnosť vypnutia zápätia s informácií o odosielateľovi. Štandardne zapnuté

Príkladová URL s dodatočnými parametrami odoslanými metódou GET:

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

Vyššie uvedený webhook pošle pozvanie na [email protected] Ak v obsahu šablóny pozvánky (id_template = 1833) existujú makrá, ktoré používajú štítky respondenta, objaví sa vo svojom obsahu. Pozvánka bude zaslaná 15 minút po vytvorení webhooku.

Dôležité!

V prípade, že bude pozvánka odoslaná respondentovi, ktorý sa odhlásil z prijímania pozvánok do prieskumov, vráti webhook nasledujúce chybu:

{"type":"error","msg":"Respondents not found"}

Ak je vyčerpaný limit možných pozvánok, webhook vráti nasledujúce chybu:

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

Pozvánka bude odoslaná podľa nastavenia poštového servera konta používateľa.

Na co pamatovat?

  • Pre získanie hodnôt parametrov: id_account, id_survey, id_template nás prosím kontaktujte.

Pomohol Vám tento článok?

Ďakujeme za odpoveď