Uitgaande Webhooks

Over Uitgaande Webhooks

In algemene termen is een webhook hoe applicaties automatisch met elkaar communiceren. Met andere woorden, er wordt over het web een bericht verstuurd dat automatisch wordt geactiveerd zodra een specifieke gebeurtenis plaatsvindt. De automatisering van de uitgaande webhook wordt geactiveerd wanneer een respondent uw enquête voltooit en hun reactie wordt verzonden naar een extern systeem naar keuze.

Elke keer als de automatisering van de uitgaande webhook geactiveerd wordt, wordt er een nieuwe automatiseringsuitvoering gecreëerd. Deze uitvoeringen vertegenwoordigen momenten waarop uw uitgaande webhook een enquêterespons verzendt naar het gespecificeerde externe systeem. Met Enalyzer kunt u gemakkelijk uw automatiseringsuitvoeringen bekijken en beheren.

Webhooks zijn bedoeld voor gebruikers die weten hoe ze ermee om moeten gaan. Let op dat we uw code niet kunnen troubleshooten of stap-voor-stap ontwikkelingsinstructies kunnen geven.

Maak een Uitgaande Webhook Automatisering

Om een uitgaande webhook automatisering op te zetten, moet je:

1. Ga naar het automatiseringsgedeelte () en klik op Enalyzer in het zijmenu.
2. In het zijmenu, klik op Enalyzer.
3. Klik op automatisering aanmaken. Als je al een of meer automatiseringen hebt, klik dan op het automatisering toevoegen icoon () om een automatisering toe te voegen.
4. Selecteer de webhooks optie en klik op uitgaande webhook.
5. Kies welke variabelen je wilt opnemen in je overdracht. Je kunt ervoor kiezen om alle variabelen te include of specifieke variabelen in je dataoverdracht.
   1. Deze optie zal al je enquêtevragen en achtergrondvariabelen opnemen in de dataoverdracht.
      1. Gebruik het dropdownmenu om de includeer alle variabelen optie te selecteren
      2. Klik volgende.
   2. Deze optie stelt je in staat om te selecteren welke enquêtevragen en achtergrondvariabelen je wilt opnemen in je dataoverdracht.
      1. Gebruik het dropdownmenu om de includeer specifieke variabelen optie te selecteren en klik volgende.
      2. Selecteer de vragen en achtergrondvariabelen die je wilt opnemen in je dataoverdracht en klik toevoegen.
6. Selecteer de variabellabels die de webhook moet gebruiken. Je kunt kiezen tussen:
   • Automatisch gegenereerde labels: deze worden gegenereerd door Enalyzer en zijn dezelfde labels als de automatisch gegenereerde labels in de response data downloads.
   • Datalabels: Je kunt datalabels gebruiken die je zelf kunt aanpassen onder je enquête-instellingen. 
7. Voeg de URL toe waarnaar de webhook automatisering de gegevens zal versturen.
8. Klik op de test verbinding knop. Zodra je verbinding succesvol is, klik volgende.
9. Geef je automatisering een naam en klik volgende.
10. Stel de status van de automatisering in. Standaard is deze ingeschakeld, echter, je kunt deze uitschakelen voordat je het creëert.
11. Wanneer je klaar bent om je automatisering te creëren, klik klaar.

Gegevenslabels Aanpassen

Wanneer u een achtergrondvariabele of vraag aanmaakt, genereert Enalyzer automatisch een label dat u kunt vinden in de download van responsgegevens. Met gegevenslabels kunt u labels voor uw enquêteachtergrondvariabelen en vragen voor uitgaande webhooks aanpassen om zo de output van API-oproepen te beheersen.

Uw gegevenslabels worden gedefinieerd onder uw enquête-instellingen, u hoeft alleen maar:

1. Ga naar het enquêtegebied () en open uw enquête.
2. In het zijmenu, klik op instellingen.
3. Onder gegevensinstellingen, klik op gegevenslabels.
4. U ziet een overzicht van alle enquêtevariabelen (achtergrondvariabelen en vraagelementen) aan de linkerkant. Aan de rechterkant ziet u uw gegevenslabels. Standaard worden de gegevenslabels automatisch gegenereerd op basis van de corresponderende achtergrondvariabelen/enquête-elementen, u kunt echter uw eigen waarden definiëren.

Gegevenslabels moeten uniek zijn, mogen geen speciale tekens bevatten en zijn beperkt tot 100 tekens.

Gegevenslabels kunnen alleen worden gedefinieerd voor achtergrondvariabelen en vragen, maar niet voor responsmogelijkheden.

Gegevenslabels worden niet gekopieerd wanneer vragen worden gekopieerd, maar ze worden wel gekopieerd wanneer enquêtes worden gekopieerd of wanneer de enquête als een sjabloon wordt gedeeld.

Details van Automatiseringsruns Bekijken

Elke keer dat de uitgaande webhook-automatisering wordt uitgevoerd, creëert het een nieuwe run. Automatiseringsruns zijn de instanties waarbij je uitgaande webhook een enquêterespons overdraagt naar het gespecificeerde externe systeem. Zodra de uitgaande webhook-automatisering begint te lopen, kan je de automatiseringsruns die het creëert bekijken. Elke automatiseringsrun kan een andere status hebben. De mogelijke statussen zijn:

• Gepland: de uitgaande webhook-automatisering is gepland voor een later tijdstip maar heeft nog niet gedraaid.
• Mislukt: de uitgaande webhook-automatisering is op een fout gestuit en kon niet draaien.
• Actief: de uitgaande webhook-automatisering is momenteel bezig.
• Succesvol: de uitgaande webhook-automatisering is succesvol voltooid en de enquêterespons is naar het externe systeem verzonden.

Om details over een automatiseringsrun te bekijken, hoef je alleen maar:

1. Naar het automatiseringsoverzicht te gaan () en vervolgens op Enalyzer in het zijmenu te klikken.
2. In het zijmenu op Enalyzer klikken.
3. Op de automatisering klikken.
4. Onder logboek, klik op automatiseringsruns.
5. Om de details van een automatiseringsrun te bekijken, klik simpelweg op de run.
6. De details van de automatiseringsrun omvatten:
   • Voornaam en achternaam: de run zal de voornaam en achternaam van de respondent weergeven indien beschikbaar.
   • Status: de runstatus, alsook de datum en tijd waarop deze status verkregen werd.
   • Aanmaaktijd: de datum en tijd waarop de run werd gecreëerd.
   • Push URL: de URL waar de enquêterespons naartoe gestuurd is.
   • Uitgaand bericht: de gegevens die naar het externe systeem zijn verzonden.

Runs van anonieme enquêtes zullen niet de voornamen, achternamen of e-mails van respondenten weergeven. In plaats daarvan wordt de run "Anoniem" genoemd.

Filter Automatiseringsruns

U kunt uw automatiseringsruns filteren op status, tijdperiode of naam. Dit zal u helpen om uw runs te sorteren en ze gemakkelijker te beheren, bijvoorbeeld, u kunt alle mislukte runs vinden en zien wat er gebeurd is of ze opnieuw afspelen.

Om uw automatiseringsruns te filteren, moet u:

1. Ga naar het automatiseringsgedeelte () en klik op Enalyzer in het zijmenu.
2. In het zijmenu, klik op Enalyzer.
3. Klik op de automatisering.
4. Onder log, klik op automatiseringsruns.
5. Klik op de knop filter.
6. U heeft de volgende opties om runs te filteren, en u kunt zo veel filters toevoegen als nodig om door hen heen te zoeken:
   • Zoek op naam of e-mailadres: Typ een e-mailadres of een naam in het zoekveld. Dit verwijst naar de waarde van de enquêterespons.
   • Status: Filter op de status van de run.
   • Tijdperiode: Filter op de tijdperiode gebaseerd op de aanmaakdatum van de run.
     

     Automatiseringsruns worden slechts 14 dagen bewaard, daarom is het tijdperiode filter beperkt tot 14 dagen in het verleden.

7. Wanneer u klaar bent met het toevoegen van alle filters, klik op de knop toepassen om de lijst met automatiseringsruns te filteren en het bewerk filter runs zijmenu te sluiten.

Automatisering Automatisch Opnieuw Afspelen

Er zijn meerdere redenen waarom je een uitvoering opnieuw zou willen afspelen. De meest voorkomende reden is als deze gefaald heeft, echter wil je misschien de gegevens opnieuw versturen of een uitvoering afspelen die voor een later tijdstip gepland staat. Om je uitvoeringen opnieuw af te spelen, hoef je alleen maar:

1. Naar het automatiseringsgedeelte te gaan () en klik op Enalyzer in het zijmenu.
2. In het zijmenu, klik op Enalyzer.
3. Klik op de automatisering.
4. Onder logboek, klik op automatiseringsuitvoeringen.
5. Klik op het actiemenu en selecteer opnieuw afspelen.
6. Selecteer de uitvoering(en) die je opnieuw wilt afspelen en klik op de opnieuw afspelen knop.

Foutmeldingen Ontvangen

Uitgaande webhooks kunnen om verschillende redenen falen, wat ertoe kan leiden dat uw automatisering wordt uitgeschakeld. Wat de reden ook is, u kunt e-mailfoutmeldingen inschakelen voor uw automatisering. U kunt de persoon(en) definiëren die deze meldingen moeten ontvangen.

Om foutmeldingen in te schakelen, moet u:

1. Ga naar het gebied van de automatiseringen () en klik op Enalyzer in het zijmenu.
2. Klik op de automatisering waarvoor u foutmeldingen wilt inschakelen.
3. Schakel onder foutmeldingen de instelling e-mailmeldingen in.
4. Klik op ontvanger toevoegen en voer het e-mailadres in dat de e-mails met foutmeldingen zal ontvangen. Herhaal deze stap om meer ontvangers toe te voegen.
5. Uw wijzigingen worden direct opgeslagen.