Instellingen

Webhooks instellen

Laat je site een ander systeem verwittigen zodra er iets gebeurt, zonder dat iemand hoeft over te typen.

Doelgroep: Beheerder, OntwikkelaarVereiste toegang: Algemene instellingenGecontroleerd op Taal: Nederlands

Een webhook is een telefoontje van je site naar een ander systeem. Gebeurt er iets, bijvoorbeeld een nieuwe bestelling of een nieuwe inzending, dan stuurt Nimbu daar meteen een bericht over naar een adres dat jij opgeeft. Het andere systeem hoeft niet te blijven vragen of er al iets nieuws is.

Zonder webhook zit er altijd iemand tussen die gegevens overtypt of exporteert. Met een webhook gebeurt dat binnen een seconde en zonder tikfouten.

Wanneer je er een nodig hebt

Nuttig wanneer een ander systeem iets moet doen op het moment dat er in Nimbu iets verandert: een nieuwsbriefdienst die een inschrijving oppikt, een boekhoudpakket dat een bestelling binnenkrijgt, een intern dashboard dat wil bijhouden hoeveel aanvragen er zijn.

Niet nuttig wanneer je gewoon wilt weten wat er gebeurd is. Daarvoor volstaat een e-mailmelding of het overzicht in de admin.

Waar ze staan

Webhooks hebben geen eigen menu-item. Ze staan als een sectie op Push & integraties, onder de kop Ontwikkelaar in het instellingenmenu. Scroll op dat scherm voorbij de pushmeldingen en de authenticatiediensten tot je de webhooks ziet.

Het scherm Instellingen, Pushmeldingen en integraties met de secties Pushmeldingen en Authenticatiediensten.Volledig formaat bekijken
Webhooks staan op Instellingen, Push & integraties; bovenaan dat scherm staan de pushmeldingen en de authenticatiediensten, de sectie Webhooks staat lager op de pagina.

De demo-site heeft geen webhooks staan. Op een site die er nog geen heeft, blijft de sectie leeg tot je er een toevoegt.

Wat een webhook bevat

Het venster Nieuwe webhook maken vraagt drie dingen.

Bij Webhook URL vul je het adres in waar Nimbu naartoe stuurt. Het scherm zegt het zo: "We sturen een HTTP POST-verzoek naar de url die je opgeeft." Dat adres komt van het ontvangende systeem, en dat systeem moet er al klaar voor zijn. Een adres verzinnen werkt niet.

Bij Triggers kies je de gebeurtenissen waarvoor de webhook moet afgaan. Kies er zo weinig mogelijk. Elke gebeurtenis die de ontvanger negeert, is verkeer dat je later moet uitzoeken wanneer er iets misloopt. Welke gebeurtenissen in de lijst staan, hangt af van wat er op je site draait; open het veld om te zien wat je site aanbiedt.

Met Channel beperk je de webhook tot één channel. Laat je dat leeg, dan gaat hij af voor alle channels. Gebruik je een webhook voor de inzendingen van je contactformulier, vul dat channel dan in, anders krijgt de ontvanger ook alles van je andere channels.

Het venster Nieuwe webhook maken met de velden Webhook URL en Triggers.Volledig formaat bekijken
Het venster Nieuwe webhook maken vraagt een Webhook URL en de triggers waarop de webhook moet afgaan.

Er een aanmaken

  1. Vraag het ontvangende systeem om het adres waarnaar Nimbu moet sturen.
  2. Open Push & integraties in het instellingenmenu en zoek de sectie met webhooks.
  3. Kies de actie om een webhook toe te voegen. Het venster Nieuwe webhook maken verschijnt.
  4. Plak het adres, kies de triggers en vul eventueel een channel in.
  5. Bevestig met Maak, en laat het andere systeem controleren of het bericht aankomt.

Het venster is de enige weg. Er is geen apart webadres voor het aanmaakformulier dat je rechtstreeks kunt openen.

Stap vijf sla je niet over. Een webhook die je bewaart, ziet er in de admin precies hetzelfde uit of het bericht nu aankomt of niet.

Het adres is een sleutel

Wie het adres van je webhook kent, kan er nepberichten naartoe sturen. Behandel het als een wachtwoord: niet in een openbare repository, niet in een ticket, niet in een gedeelde spreadsheet. Lekt het toch, laat het ontvangende systeem dan een nieuw adres uitdelen.

Als er niets aankomt

Vraag de ontvangende kant eerst of ze iets zien binnenkomen. Meestal ligt het daar: een adres met een typfout, een systeem dat het bericht wel ontvangt maar afwijst, of een dienst die tijdelijk uitlag.

Het versturen is niet hetzelfde als het verwerken. Nimbu kan het bericht netjes hebben afgeleverd terwijl het ontvangende systeem het weggooit.

Betrek de ontwikkelaar van de koppeling wanneer je er samen niet uitkomt. Die kan aan beide kanten meekijken.

Verwant, maar iets anders

Boven de webhooks staan op hetzelfde scherm de koppelingen met diensten die Nimbu zelf kent, elk met een eigen configuratie achter het tandwiel. Een webhook is algemener: die stuurt naar elk adres dat je opgeeft. Zie Pushmeldingen en integraties voor die lijst.

Bestaat er voor jouw dienst een kant-en-klare integratie, gebruik die dan liever dan een eigen webhook.