Skip to main content
Webhooks stellen u in staat om realtime meldingen van Ritlijst te ontvangen in uw eigen systemen, zodra er een ritgebeurtenis plaatsvindt. In plaats van dat uw software periodiek de Ritlijst API bevraagt, stuurt Ritlijst een HTTP-verzoek naar uw eigen endpoint op het moment dat er iets verandert. Dit maakt directe verwerking mogelijk zonder vertraging.

​
Beschikbare events

Ritlijst ondersteunt de volgende webhook-events:
EventOmschrijving
rit.aangemaaktEr is een nieuwe rit aangemaakt in Ritlijst.
rit.gewijzigdEen bestaande rit is bijgewerkt, bijvoorbeeld een gewijzigde bestemming of chauffeur.
rit.verwijderdEen rit is verwijderd uit Ritlijst.

​
Webhook instellen

1

Open Instellingen → Webhooks

Log in op het Ritlijst portaal via portaal.ritlijst.nl en navigeer naar Instellingen → Webhooks.
2

Voeg een nieuwe webhook toe

Klik op de knop Webhook toevoegen om het configuratieformulier te openen.
3

Voer uw endpoint-URL in

Vul de URL in van het endpoint dat de webhook-verzoeken moet ontvangen. Het endpoint moet bereikbaar zijn via HTTPS.
4

Selecteer de gewenste events

Vink de events aan waarop u wilt abonneren, zoals rit.aangemaakt, rit.gewijzigd of rit.verwijderd. U kunt meerdere events selecteren voor één webhook.
5

Sla de webhook op

Klik op Opslaan. De webhook is direct actief en stuurt voortaan meldingen naar uw endpoint bij de geselecteerde events.
Uw webhook-endpoint moet bereikbaar zijn via HTTPS. HTTP-endpoints worden niet geaccepteerd.

​
Webhook payload

Bij elk webhook-event stuurt Ritlijst een POST-verzoek naar uw endpoint met een JSON-payload. Hieronder ziet u een voorbeeldpayload voor het event rit.aangemaakt: 
{
  "event": "rit.aangemaakt",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {
    "id": "rit_123456",
    "datum": "2024-01-15",
    "chauffeur": "Jan de Vries",
    "beginlocatie": "Amsterdam",
    "eindlocatie": "Rotterdam",
    "kilometers": 75
  }
}
Het veld event geeft aan welk type gebeurtenis heeft plaatsgevonden. Het veld timestamp bevat het tijdstip van de gebeurtenis in UTC. Het object data bevat de details van de betreffende rit.
Gebruik een tool zoals RequestBin of Webhook.site om uw webhook te testen voordat u deze in productie neemt.

​
Beveiliging

Elk webhook-verzoek van Ritlijst bevat een X-Ritlijst-Signature-header. Deze header bevat een cryptografische handtekening waarmee u kunt verifiëren dat het verzoek afkomstig is van Ritlijst en niet van een onbevoegde derde partij. Valideer de handtekening aan de ontvangende kant door de payload te hashen met uw gedeelde geheime sleutel (te vinden onder Instellingen → Webhooks) en de uitkomst te vergelijken met de waarde in de X-Ritlijst-Signature-header. Verwerk het verzoek alleen als de handtekeningen overeenkomen.
Ritlijst verwacht dat uw endpoint een 200 OK-respons teruggeeft binnen 10 seconden. Bij een time-out of een foutrespons probeert Ritlijst de webhook nogmaals te verzenden, met een toenemend interval tussen de pogingen.