Naar de hoofdinhoud

Een webhook instellen in Plug&Pay

Maak een webhook aan in Plug&Pay

Geschreven door Bryan Schoenmaker

In Plug&Pay heb je de mogelijkheid om een webhook in te stellen. Het instellen van een webhook zorgt ervoor dat een bepaalde actie wordt uitgevoerd in een ander systeem of andere tool na het plaatsen van een bestelling, na het verlopen van een abonnement of het accepteren van een affiliate.

In deze handleiding lees je hoe je een webhook aanmaakt en instelt in Plug&Pay.


Wat zijn webhooks?

Webhooks kun je zien als automatische berichtjes die Plug&Pay naar een ander systeem stuurt zodra er iets gebeurt. Het andere systeem kan daarna iets doen, zoals een klant aanmelden, een e-mail sturen of een factuur maken.

Webhooks zorgen ervoor dat Plug&Pay gebeurtenissen direct doorgeeft aan andere systemen, zodat alles automatisch blijft lopen zonder dat je zelf iets hoeft te doen.

Voorbeeld: Het instellen van een webhook zorgt ervoor dat na het plaatsen van een bestelling jouw klant automatisch inloggegevens van een omgeving ontvangt.


Welke triggers kan ik gebruiken?

Met Plug&Pay kan je de volgende startmomenten instellen voor een webhook:

  • Affiliate geaccepteerd

  • Affiliate afgewezen

  • Affiliate gestopt

  • Factuur aangemaakt

  • Bestelling betaald

  • Abonnement geëindigd


Welke gegevens worden verstuurd via webhooks?

❗️Deze informatie geldt alleen voor Webhooks V2

Webhooks in Plug&Pay sturen alleen een event payload. Die bevat o.a.:

  • trigger_type

    • bijv. order_created

  • triggerable_id

    • bijv. order_ID

  • triggerable_type

    • bijv. orders

  • sent_at

  • tenant_id

  • rule_id

Je moet zelf de actuele data ophalen via de API. Dit doe je door middel van een URL. De structuur van deze URL verschilt met de data die je ophaalt.

Hieronder volgen een paar voorbeelden 👇

Als triggerable_type order is

Als triggerable_type subscription is

Het voordeel hiervan is dat je altijd de meest actuele data bij de hand hebt. Omdat je de data pas ophaalt wanneer jij de webhook verwerkt, kun je controleren of de info nog klopt (bijv. met sent_at) of data later ophalen als je webhook vertraagd aankomt.

Hierdoor ben je ook meer flexibel in het ophalen van verschillende soorten data.


Een webhook toevoegen

Binnen Plug&Pay heb je de mogelijkheid om een webhook in te stellen voor een specifiek(e) product/betaalpagina of een algemene webhook voor alle producten en alle betaalpagina's.

Een algemene webhook instellen

Een universele webhook wordt iedere keer aangeroepen wanneer de gekozen trigger plaatsvindt. Bijvoorbeeld bij iedere bestelling of elke geaccepteerde affiliate.

Ga naar Instellingen > Koppelingen om te beginnen. Klik op Koppeling toevoegen, geef je regel een naam, kies een trigger en selecteer bij 'Actie' de Webhook V2 optie.

Vul hier de webhook URL in van het systeem waar je een koppeling mee wilt maken. Klik op 'Regel aanmaken' om je nieuwe webhook op te slaan.


Een webhook per product instellen

Indien je een webhook wil instellen die niet bij elke bestelling wordt aangeroepen, maar alleen voor een specifiek product, volg dan de volgende stappen.

Navigeer naar Producten en open het gewenste product. Ga naar het Koppelingen tabblad en voeg een nieuwe koppeling toe.

Geef je regel een naam, kies de trigger, selecteer Webhook V2 en vul de webhook URL in. Sla je regel op via 'Regel aanmaken'.


Een webhook per betaalpagina instellen

Indien je een webhook wil instellen die niet bij elke bestelling wordt aangeroepen, maar alleen voor een specifieke betaalpagina, volg dan de volgende stappen.

Navigeer naar Pagina's > Betaalpagina's en open de gewenste pagina. Ga naar het Koppelingen tabblad en voeg een nieuwe koppeling toe.

Geef je regel een naam, kies de trigger, selecteer Webhook V2 en vul de webhook URL in. Sla je regel op via 'Regel aanmaken'.


Webhooksleutel 🔑

Je kan je webhooks ook verifiëren met een webhooksleutel. Deze verificatie is optioneel, en gebruik je om te verifiëren dat de meegestuurde data afkomstig is vanaf jouw Plug&Pay-omgeving.

De webhooksleutel vind je onder Instellingen > Ontwikkelaars.


Goed om te weten

  • We gebruiken JSON format in alle Webhooks V2 payloads

  • Indien je een universele koppeling hebt gemaakt met de trigger Factuur aangemaakt, wordt er ook een webhook aangeroepen na een succevolle transactie met de one-click upsell.

  • Wil je bij een specifieke upsell een webhook aanroepen? Dan kan je via de instellingen van de upsell bij het Geavanceerd tabblad het webhookveld invullen met de gewenste webhook URL.

  • Koppelen met Huddle? Lees dan deze handleiding 📖

  • Koppelen met MailBlue(ActiveCampaign)? Lees dan deze handleiding 📖

Was dit een antwoord op uw vraag?