Uitgaande Webhooks

Over Uitgaande Webhooks

In algemene termen is een webhook hoe applicaties automatisch met elkaar communiceren. Met andere woorden, er wordt automatisch een bericht over het web verstuurd wanneer 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 dat de automatisering van de uitgaande webhook wordt geactiveerd, wordt een nieuwe automatiseringsrun gecreëerd. Deze runs vertegenwoordigen instanties waarbij uw uitgaande webhook een enquêterespons verstuurt naar het gespecificeerde externe systeem. Met Enalyzer kunt u uw automatiseringsruns eenvoudig 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 stapsgewijze ontwikkelinstructies kunnen geven.

Een uitgaande webhook-automatisering opzetten

Om een uitgaande webhook-automatisering in te stellen, moet je:

  1. Naar het automatiseringsgebied gaan () en klikken 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 icoon voor automatisering toevoegen () om een automatisering toe te voegen.
  4. Selecteer de optie webhooks en klik op uitgaande webhook.
  5. Kies welke variabelen je wilt opnemen in je overdracht. Je kunt ervoor kiezen om alle variabelen of specifieke variabelen in je gegevensoverdracht op te nemen.
    1. Deze optie zal al je vragen uit de enquête en achtergrondvariabelen in de gegevensoverdracht opnemen.
      1. Gebruik het dropdownmenu om de optie alle variabelen opnemen 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 gegevensoverdracht.
      1. Gebruik het dropdownmenu om de optie specifieke variabelen opnemen te selecteren en klik volgende.
      2. Selecteer de vragen en achtergrondvariabelen die je wilt opnemen in je gegevensoverdracht en klik toevoegen.
  6. Selecteer de variabele labels 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 gegevensdownloads van de respons.
    • Gegevenslabels: Je kunt gegevenslabels gebruiken die je zelf kunt aanpassen onder je enquête-instellingen. 
  7. Voeg de URL toe waar de webhook-automatisering de gegevens naartoe zal sturen.
  8. Klik op de knop verbinding testen. Zodra je verbinding succesvol is, klik op volgende.
  9. Geef je automatisering een naam en klik volgende.
  10. Stel de automatiseringsstatus in. Standaard is deze ingeschakeld, maar je kunt deze uitschakelen voordat je deze maakt.
  11. Als je klaar bent om je automatisering aan te maken, klik op klaar.

Gegevenslabels Aanpassen

Wanneer je een achtergrondvariabele of vraag maakt, genereert Enalyzer automatisch een label dat je kunt vinden in de gegevensdownload van reacties. Gegevenslabels stellen je in staat om labels voor je achtergrondvariabelen en vragen van je enquête aan te passen voor uitgaande webhooks om zo de uitvoer van API-aanroepen te reguleren.

Je definieert je gegevenslabels in je enquête-instellingen, het enige wat je hoeft te doen is:

  1. Ga naar het enquêtegebied (SurveyAreaIcon.png) en open je enquête.
  2. In het zijmenu klik je op instellingen.
  3. Onder gegevensinstellingen, klik je op gegevenslabels.
  4. Je ziet een overzicht van alle enquêtevariabelen (achtergrondvariabelen en vragen) aan de linkerkant. Aan de rechterkant zie je je gegevenslabels. Standaard worden de gegevenslabels automatisch gegenereerd op basis van de overeenkomstige achtergrondvariabelen/vragen, maar je kunt je eigen waarden definiëren.

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

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

Gegevenslabels worden niet gekopieerd bij het kopiëren van vragen, maar ze worden wel gekopieerd bij het kopiëren van enquêtes of wanneer de enquête als sjabloon wordt gedeeld.

Details van Automatiseringsrun Bekijken

Elke keer dat de uitgaande webhook automatisering wordt uitgevoerd, wordt er een nieuwe run gecreëerd. Automatiseringsruns zijn de instanties waarin je uitgaande webhook een onderzoeksresponse overdraagt naar het gespecificeerde externe systeem. Zodra de uitgaande webhook automatisering begint te lopen, kun 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 is nog niet uitgevoerd.
  • Mislukt: de uitgaande webhook automatisering is op een fout gestuit en heeft niet kunnen lopen.
  • Wordt afgespeeld: de uitgaande webhook automatisering wordt momenteel afgespeeld.
  • Succesvol: de uitgaande webhook automatisering is met succes voltooid en de onderzoeksrespons is naar het externe systeem verzonden.

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

  1. Naar het automatiseringsgebied te gaan () 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. Om de details van een automatiseringsrun te bekijken, klik je eenvoudigweg op de run.
  6. De details van de automatiseringsrun bevatten:
    • Voornaam en achternaam: de run zal de voornaam en achternaam van de respondent weergeven indien beschikbaar.
    • Status: de run status, evenals de datum en tijd dat het die status kreeg.
    • Aanmaaktijd: de datum en tijd dat de run werd aangemaakt.
    • Push URL: de URL waarop de onderzoeksrespons is geplaatst.
    • Uitgaand bericht: de gegevens die naar het externe systeem zijn verzonden.

Runs van anonieme onderzoeken zullen de voornamen, achternamen of e-mails van respondenten niet weergeven. In plaats daarvan zal de run de naam "Anoniem" krijgen.

Filter Automatisering Uitvoeringen

Je kunt je automatisering uitvoeringen filteren op status, tijdperiode of naam. Dit zal je helpen om je uitvoeringen te sorteren en makkelijker te beheren, bijvoorbeeld, je kunt alle mislukte uitvoeringen vinden en zien wat er gebeurd is of ze opnieuw afspelen.

Om je automatisering uitvoeringen te filteren, moet je:

  1. Ga naar het automatiseringsgebied () en klik op Enalyzer in het zijmenu.
  2. In het zijmenu, klik op Enalyzer.
  3. Klik op de automatisering.
  4. Onder logboek, klik op automatisering uitvoeringen.
  5. Klik op de filter knop.
  6. Je hebt de volgende opties om uitvoeringen te filteren, en je kunt zoveel filters toevoegen als nodig is om erdoorheen 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 uitvoering.
    • Tijdperiode: Filter op de tijdperiode gebaseerd op de creatiedatum van de uitvoering.

      Automatisering uitvoeringen worden slechts 14 dagen bewaard, daarom is de filter voor tijdperk beperkt tot 14 dagen in het verleden.

  7. Nadat je alle filters hebt toegevoegd, klik op de toepassen knop om de lijst met automatisering uitvoeringen te filteren en het bewerkingsmenu voor filters te sluiten.

Automatiseringen Opnieuw Afspelen

Er zijn meerdere redenen waarom je een uitvoering zou willen herhalen. De meest voorkomende reden is als het niet gelukt is, maar je wilt misschien de gegevens opnieuw versturen of een uitvoering afspelen die gepland staat voor een later tijdstip. Om je uitvoeringen opnieuw af te spelen, hoef je alleen het volgende te doen:

  1. Ga naar het automatiseringsgebied () 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 en ervoor zorgen dat je automatisering wordt uitgeschakeld. Wat de reden ook is, je kunt e-mail foutmeldingen inschakelen voor je automatisering. Je kunt de persoon (personen) definiëren die deze meldingen moeten ontvangen.

Om foutmeldingen in te schakelen, moet je:

  1. Ga naar het automatiseringsgebied (AutomationsIcon.png) en klik op Enalyzer in het zijmenu.
  2. Klik op de automatisering waarvoor je 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-mailmeldingen over fouten zal ontvangen. Herhaal deze stap om meer ontvangers toe te voegen.
  5. Je wijzigingen worden direct opgeslagen.

Was dit artikel nuttig?

Aantal gebruikers dat dit nuttig vond: 0 van 0