Je eigen software koppelen via API en webhooks
Wil je eBox- en MyMinfin-berichten automatisch verwerken in je ERP, DMS of een eigen applicatie? Zo werkt de koppeling met Boxflow.
Wat heb je nodig?
- Een Boxflow-account met minstens één gekoppelde onderneming.
- Een HTTPS-endpoint in je eigen software dat verzoeken kan ontvangen.
- Een API-token, aan te maken in je Boxflow-profiel.
Hoe de koppeling werkt
-
1
Nieuw bericht
Boxflow haalt een nieuw bericht op uit eBox Enterprise of MyMinfin.
-
2
Automatisering
Een automatisering met jouw voorwaarden verstuurt een webhook naar je endpoint.
-
3
Jouw software
Je endpoint ontvangt de gegevens en haalt indien nodig details en bijlagen op via de REST API.
Stap voor stap
-
1
Maak een API-token aan
Maak in je Boxflow-profiel een API-token aan. Bewaar het veilig: je gebruikt het als Bearer-token voor de REST API.
-
2
Voorzie een endpoint
Voorzie in je software een HTTPS-endpoint dat webhooks ontvangt en snel een 2xx-antwoord terugstuurt. Verwerk het bericht bij voorkeur asynchroon.
-
3
Voeg een webhook-actie toe
Maak in Boxflow een automatisering met de gewenste voorwaarden en voeg een webhook-actie toe. Kies de HTTP-methode (bv. POST), het formaat (JSON of XML) en de authenticatie.
-
4
Stel de inhoud samen
Bepaal zelf de inhoud van de webhook met placeholders zoals {{ message.uuid }}, {{ message.subject }}, {{ sender.name }} en {{ company.name }}. Zo ontvangt je software precies de velden die ze nodig heeft.
-
5
Haal details en bijlagen op
Gebruik het bericht-ID uit de webhook om via de REST API de details en bijlagen van het bericht op te halen.
Authenticatie van webhooks
- Geen authenticatie (enkel aan te raden voor tests).
- Basic authentication met gebruikersnaam en wachtwoord.
- Bearer-token in de Authorization-header.
- API-sleutel in een header naar keuze.
- Daarnaast kan je eigen headers toevoegen.
Herhaalpogingen
- Bij een tijdelijke fout (time-out, 408, 429 of 5xx) probeert Boxflow het automatisch opnieuw.
- Tot 10 pogingen, met toenemende wachttijden gespreid over ongeveer 3 dagen.
- Elke poging wordt gelogd in de audittrail van het bericht.
- Tip: maak je endpoint idempotent op basis van het bericht-ID, zodat een herhaalde levering geen dubbels oplevert.
REST API
- Lijst van workspaces en gebruikers.
- Berichten van een workspace oplijsten en details van een bericht ophalen.
- Bijlagen van een bericht oplijsten en downloaden.
- Authenticatie met een Bearer-token; de volledige documentatie vind je op /apidocs.
Veelgestelde vragen
Welke gegevens zitten in een Boxflow-webhook?
Dat bepaal je zelf. Je stelt de inhoud samen met placeholders voor het bericht, de afzender, de onderneming, de status en de workspace.
Wat als mijn server even niet bereikbaar is?
Boxflow probeert het automatisch opnieuw, tot 10 keer gespreid over ongeveer 3 dagen.
Hoe download ik bijlagen via de API?
Met het bericht-ID uit de webhook lijst je de bijlagen van het bericht op en download je elke bijlage via de REST API, met je API-token als Bearer-token.
Lees ook
Billit
Overheidsbrieven rechtstreeks in Billit, via e-mail
Lees meerExact Online
Overheidsbrieven rechtstreeks in Exact Online, via e-mail
Lees meerMake.com
eBox-berichten automatisch in SharePoint
Lees meerOdoo
Overheidsbrieven rechtstreeks in Odoo, via e-mail
Lees meerPower Automate
eBox-berichten in SharePoint of Teams met Power Automate
Lees meerSingle sign-on
Aanmelden met Microsoft Entra ID of Google Workspace
Lees meerZapier
Binnenkort: koppel Boxflow aan duizenden apps
Lees meerKlaar om je eBox op automatische piloot te zetten?
Koppel je eerste onderneming gratis en ontvang je overheidsberichten voortaan waar je ze nodig hebt.