Sprievodca - API

Použitie webhook pre pridanie respondenta do databázy príjemcov

Pridanie respondenta do databázy príjemcov, bez nutnosti odoslania pozvánky, je možné použitím tzv. Webhook metódy. Webhook nie je nič iné ako URL adresa, 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]?id_survey=123456&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, add-respondent
  • dodatecne_parametry – dodatočné parametre určujúce respondenta. Dodatočné parametre môžu byť vložené metódami GET alebo POST. 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 do ktorého má byť respondent pridaný (pre získanie hodnoty nás kontaktujte). povinný parameter

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&[email protected]&l1=Martin&l2=Novak&l3=CEO&l4=VIP&l5=775123456

Vyššie uvedený webhook pridá respondenta s adresou [email protected] do prieskumu s ID = 399793. Respondent bude uvedený s hodnotami: Martin, Novák, CEO, VIP, 775123456. V tomto príklade sú štítky respondenta: Meno, Priezvisko, Funkcia, Segment, a Telefónne číslo.

Príkladová odpoveď servera

{
"type":"success",
"msg":"Respondent has been saved on the survey's mailing list",
"data":
{"id_respondent":52909566,"token":"96BD97"}
}

Na čo pamätať?

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

Pomohol Vám tento článok?

Ďakujeme za odpoveď