Inleiding
Een webhook is een kort bericht dat RentVisie naar een ander systeem stuurt op het moment dat er iets verandert, zodat dat systeem niet steeds hoeft te vragen. Op het scherm met de kop Webhooks, met daaronder We send a short message to these URLs when data changes. Failed messages are retried up to 5 times., stel je in waarheen de berichten gaan. Rechtsboven staat een knop New webhook (Nieuwe webhook). Daaronder staat een kaart met de kop Endpoints: een tabel met één rij per adres waarnaar je stuurt, met de kolommen Description (Omschrijving), Webhook URL en Status (Active of Inactive), en aan het eind van elke rij een potlood- en een prullenbakpictogram.
Je komt hier wanneer:
- Je wagenparkbeheer- of planningssysteem meteen moet weten wanneer de kilometerstand of brandstofstand van een voertuig verandert.
- Je website of een ander hulpmiddel een eigen kopie van je voertuigklassen bewaart en moet horen wanneer je er een wijzigt.
- Een integratiepartner je een adres heeft gegeven om berichten naartoe te sturen.
- Je de berichten even wilt pauzeren, of wilt controleren welke adressen nog actief zijn.
Termen op dit scherm
| Het scherm zegt | Het betekent |
|---|---|
| Webhook | Eén adres waarnaar de app berichten stuurt, met de wijzigingen waarover hij berichten stuurt |
| Webhook URL | Het webadres van het andere systeem, je gegeven door wie het beheert. Het moet beginnen met https:// |
| Endpoint | Hetzelfde als een webhook: één ontvangend adres |
| Events | De soorten wijziging die een bericht veroorzaken |
| Asset group | Een voertuigklasse, zoals "compacte auto" of "bestelbus 12 m3" |
Het scherm opent vanuit de rij Webhooks op het scherm Integraties; zie Zet een integratie aan of uit. Gebruik deze pagina wanneer een ander systeem op de hoogte moet worden gebracht van wijzigingen zodra ze gebeuren.
Zo werkt het
Configuratie
Er hoeft niets eerst te worden aangezet. De rij Webhooks op het scherm Integraties heeft geen schakelaar; webhooks werken zodra je er een opslaat die Active is.
Voordat je begint: het scherm Webhooks en het scherm Integraties waarvandaan het opent, zijn alleen voor de rol Bedrijfsbeheerder (Company admin). Je hebt ook het ontvangende adres nodig van wie het andere systeem beheert, en het moet beginnen met https://. Vraag ze ook wat ze met de berichten gaan doen: de app verstuurt ze alleen; hij kan je niet laten zien of het andere systeem ze heeft gebruikt.
Het scherm Webhooks gebruiken
Open in het hoofdmenu Beheer → Instellingen (Admin → Settings). Klik op het tegelscherm Instellingen op de tegel Integraties. Klik in de kaart Bookings & operations op Instellingen (Settings) op de rij Webhooks. Het scherm met de kop Webhooks opent.
-
Voeg een webhook toe. Klik op New webhook. Een venster met de kop Webhook opent met twee delen, Endpoint en Events.
-
Vul het deel Endpoint in.
Veld Begint als Wat het doet Wat het accepteert Webhook URL Leeg, met https:// als hint Waarheen de berichten gaan Een webadres dat begint met https://. Al het andere, of een leeg vak, wordt geweigerd Description Leeg Een naam zodat je de webhook in de lijst herkent, zoals "Wagenparkplanner" Elke tekst Active Aan Turn off to pause sending without deleting the webhook. Aan of uit -
Kies de events. Onder Events, Send a webhook when one of these changes is saved., staat een schakelaar voor elke soort wijziging. Bij een nieuwe webhook staan ze allemaal aan. Zet de schakelaars uit die het andere systeem niet nodig heeft:
Event Er wordt een bericht gestuurd wanneer Odometer reading Een kilometerstand wordt opgeslagen voor een van je voertuigen, door medewerkers, bij een overdracht, of door een tracker Fuel reading Een brandstofstand wordt opgeslagen voor een van je voertuigen Asset group Een van je voertuigklassen wordt opgeslagen -
Klik op Save. Het venster sluit en de webhook verschijnt in de tabel met de status Active. Begint het adres niet met https://, dan blijft het venster open met Enter a URL that starts with https:// onder Webhook URL. Cancel sluit het venster zonder iets op te slaan.
-
Wijzig een webhook. Klik op zijn rij, of op het potloodpictogram aan het eind ervan. Hetzelfde venster opent met de schakelaars zoals je ze achterliet. Wijzig wat je nodig hebt en klik op Save.
-
Pauzeer een webhook. Open hem, zet Active uit en klik op Save. De status toont Inactive en er worden geen berichten naartoe gestuurd totdat je hem weer aanzet.
-
Verwijder een webhook. Klik op het prullenbakpictogram aan het eind van zijn rij. De app vraagt Delete this webhook?; klik op Delete om hem te verwijderen, of op Cancel om hem te houden.
Je bent klaar wanneer de rij het juiste adres en Active toont.
Goed om te weten
Wat een bericht bevat. Elk bericht is heel kort. Het zegt wat voor soort record is veranderd (een voertuig, bij kilometer- en brandstofstanden, of een voertuigklasse), welk record via zijn nummer in RentVisie, welk event het was (Odometer reading, Fuel reading of Asset group) en het tijdstip in universele tijd (UTC). Het bevat niet de stand of de klassegegevens zelf; het andere systeem zoekt die op via zijn eigen verbinding met RentVisie. Geef je integratiepartner deze beschrijving wanneer hij de ontvangende kant instelt.
Wanneer berichten worden verstuurd. Een bericht gaat direct nadat de wijziging is opgeslagen naar elke Active webhook van je bedrijf waarbij dat event aanstaat. Een wijziging die in jouw bedrijf wordt opgeslagen, gaat nooit naar de webhook van een ander bedrijf. Voor wijzigingen van vóór het opslaan van de webhook wordt niets verstuurd: het werkt niet met terugwerkende kracht.
Als het andere systeem niet antwoordt. De app wacht maximaal 10 seconden op een antwoord. Antwoordt het andere systeem niet, of met een fout, dan probeert de app het later opnieuw, eerst na ongeveer een minuut en daarna met steeds langere pauzes tot een uur, tot 5 keer toe. Daarna wordt het bericht laten vallen. Er is op dit scherm geen lijst met mislukte berichten; vraag je integratiepartner na te gaan wat hij heeft ontvangen.
Een webhook stopt een opslag nooit. Mislukt het versturen, dan wordt de stand of klasse toch gewoon opgeslagen. Medewerkers aan de balie merken er niets van.
Opslaan vervangt de events. Als je het venster opslaat, bewaart de app precies de events die op dat moment aanstaan. Een event uitzetten en opslaan stopt die berichten meteen.
Wat je hierna doet: vertel wie het andere systeem beheert dat de webhook actief is, en vraag hem te bevestigen dat het eerste bericht aankomt. De snelste test is een kilometerstand opslaan bij een voertuig; zie De kilometerstand en brandstofstanden van een voertuig controleren en corrigeren.
Veelgestelde vragen
Waarom ontvangt het andere systeem niets, terwijl de webhook in de lijst staat? Controleer drie dingen op de rij en het venster van de webhook: de status zegt Active, het event dat je verwacht staat aan onder Events, en de Webhook URL is precies het adres dat je kreeg. Sla dan een wijziging van dat soort op, zoals een kilometerstand, en vraag de andere kant of het is aangekomen. Zo niet, dan antwoordt het andere systeem niet; de app geeft na 5 pogingen op.
Waarom blijft het venster open met "Enter a URL that starts with https://"? Het adres is leeg of begint met iets anders dan https://, bijvoorbeeld http:// of www.. Kopieer het volledige adres van je integratiepartner, beginnend met https://, en klik opnieuw op Save.
Waarom kreeg het andere systeem een bericht dat ik niet verwachtte, terwijl ik alleen een voertuigklasse wijzigde? Elke keer dat een voertuigklasse wordt opgeslagen, gaat er een Asset group-bericht uit, ook als je alleen de omschrijving of een foto wijzigde. Zet Asset group uit bij de webhook als het andere systeem het niet nodig heeft.
Kan ik een geschiedenis zien van de berichten die zijn verstuurd? Nee. Dit scherm toont alleen waarheen berichten gaan. Vraag wie het ontvangende systeem beheert na te gaan wat er aan hun kant is aangekomen.
Ik heb per ongeluk een webhook verwijderd. Kan ik hem terugkrijgen? Nee. Klik op New webhook en voer het adres, de omschrijving en de events opnieuw in.
Kan een webhook wijzigingen aan boekingen, klanten of facturen versturen? Op dit moment niet. De enige events zijn Odometer reading, Fuel reading en Asset group. Vraag RentVisie-support als je integratie andere wijzigingen nodig heeft.
Waarom vind ik het scherm Webhooks niet? Het is bereikbaar vanaf het scherm Integraties, dat alleen voor de rol Bedrijfsbeheerder is. Vraag je bedrijfsbeheerder. Zie Voeg een medewerker toe en stel diens rechten in.
Gerelateerde pagina's:
- Zet een integratie aan of uit: het scherm Integraties waarop de rij Webhooks staat.
- De kilometerstand en brandstofstanden van een voertuig controleren en corrigeren: de standen die de berichten Odometer reading en Fuel reading veroorzaken.
- Je voertuigklassen instellen: de opslagen die het bericht Asset group veroorzaken.