Met MailBlue kun je webhooks gebruiken om real-time updates over je contact- en campagneactiviteiten naar een externe bron te sturen. Denk aan het plaatsen van inloggegevens op Huddle, of het doorzetten van klantgegevens naar een software die geen directe koppeling ondersteunt. Benieuwd hoe je webhooks kunt toepassen? Lees dan vooral verder!
Let op:
- Bij het maken van een webhook moet de ontvangende applicatie POST-verzoeken accepteren en een API hebben. Daarnaast ondersteunen we alleen het verzenden van HTTPS-verzoeken naar de standaard HTTPS-poort (poort 443).
- Het is niet mogelijk om inkomende webhooks te koppelen aan MailBlue.
- Webhook payloads kunnen niet worden aangepast. Autorisatiespecificatie is beperkt tot de URL en URL-parameters.
- Onze Support-afdeling is helaas niet in staat om ondersteuning te bieden wanneer een webhook niet lijkt te werken, enkel algemeen advies over de opstelling van de webhook. Kom je er niet uit? Overweeg dan om de hulp van een technische partij in te schakelen.
Inhoudsopgave
Waar webhooks worden aangemaakt
Hoe webhook gegevens worden ontvangen
Geldige tekens en limieten voor webhooks
Wat is een webhook?
Webhooks zijn geautomatiseerde berichten die van het ene systeem naar het andere worden gestuurd wanneer een bepaalde gebeurtenis plaatsvindt. Je kunt webhooks gebruiken om gegevens van je MailBlue account te sturen naar een externe database of applicatie, zodat contact-, campagne- en dealactiviteiten in real-time worden bijgewerkt.
Bijvoorbeeld, je wilt misschien een webhook maken om gegevens naar een externe database te sturen elke keer dat een contactrecord wordt bijgewerkt, wanneer een account wordt toegevoegd, wanneer een dealtaak wordt aangemaakt of wanneer een contact op een link in je e-mail klikt.
Wat voor data kan ik versturen middels een webhook?
Hier is een lijst van de verschillende data die je kunt versturen middels een webhook:
- Account – toegevoegd of bijgewerkt
- Campagne – doorgestuurd, geopend, gedeeld, begint met verzenden
- Contact – toegevoegd of bijgewerkt in je MailBlue, toegevoegd, bijgewerkt of verwijderd op een Account in je MailBlue, notitie toegevoegd, tag toegevoegd of verwijderd, taak toegevoegd, uitgeschreven
- Deal – toegevoegd of bijgewerkt, notitie toegevoegd, pijplijn toegevoegd, fase toegevoegd, taak toegevoegd of voltooid, taaktype toegevoegd
- E-mail – gebounced, beantwoord
- Link – geklikt
- Lijst – toegevoegd
Hoe maak ik een webhook aan?
Er zijn twee plaatsen waar je een webhook kunt aanmaken in MailBlue: Mijn Instellingen en Automatisering.
Mijn Instellingen
Hiermee kun je gegevens posten naar een derde partij elke keer dat een gespecificeerde actie/evenement is voltooid. Je kunt deze webhooks vinden bij 'Instellingen → Ontwikkelaar'. Vervolgens kun je op 'Voeg een webhook toe' klikken om een webhook aan te maken. Zie onderstaande schermafbeelding:
Om een webhook aan te maken onder instellingen, volg je de onderstaande stappen:
- Klik op 'Instellingen'
- Klik op 'Ontwikkelaar' in het linker menu.
- Klik op "Webhooks beheren".
- Klik op de knop "Toevoegen".
- Er verschijnt een venster. Kies het type webhook dat je wilt aanmaken.
- Op het volgende scherm vul je de velden in om je webhook aan te maken:
- Vul de naam en URL-velden in. Het URL-veld is waar de webhook naartoe zal posten wanneer de actie plaatsvindt.
- Selecteer in het dropdown-menu "Type" de actie of het evenement dat de webhook zal triggeren. Je kunt meerdere evenementen selecteren.
- Selecteer waar de actie(s) moeten worden geïnitieerd. Bijvoorbeeld, je kunt kiezen of de webhook moet worden getriggerd door een actie van een contact of een actie van een accountgebruiker.
- Selecteer de lijst waarmee de webhook moet worden geassocieerd. Dit lijstveld verschijnt alleen als het webhooktype een lijst vereist.
- Klik op de knop "Opslaan"
Webhook automatiseringsactie
Hiermee kun je gegevens naar een andere URL posten zodra een contact interactie heeft met de Webhook-actie in een automatisering. Hiervoor is het niet nodig om een webhook aan te maken bij je instellingen. Er hoeft voor deze webhook ook niet bepaald te worden hoe deze geïnitieerd wordt, aangezien deze getriggerd wordt door de automatisering.
Zo ziet de webhook actie eruit:
De volgende informatie wordt door de webhook verstuurd, wanneer deze door een automatisering getriggerd wordt:
- Voornaam
- Achternaam
- E-mailadres
- Eigen velden
- Tags
- Account
- Telefoonnummer
- Contact ID
- IP-adres
- Series ID (Automatisering ID)
Hoe dit precies in zijn werk gaat, wordt aan de hand van een voorbeeld uitgelegd in dit artikel over webhooks tussen MailBlue en Huddle.
Webhook initiatieopties
Bij het aanmaken van een webhook bij het kopje 'Ontwikkelaar' onder 'Instellingen,' moet er bepaald worden hoe een webhook getriggerd wordt. Hieronder staan de opties voor het initiëren van webhooks:
- Geïnitieerd door een contact: Deze optie voert hooks uit wanneer een contact de actie veroorzaakt. Bijvoorbeeld wanneer een contact een campagne opent.
- Geïnitieerd door een gebruiker: Voer de hooks uit wanneer een admin in het account de actie veroorzaakt. Bijvoorbeeld wanneer een contact wordt toegevoegd vanuit het admin gebied.
- Geïnitieerd door systeemprocessen: In dit geval voer je de hooks uit wanneer geautomatiseerde systemen de actie uitvoeren. Een voorbeeld hiervan is wanneer een e-mail bouncet.
- Geïnitieerd door de API: Voer de hooks uit wanneer de API-aanroep de actie veroorzaakt. Bijvoorbeeld wanneer je een contact toevoegt met de contact_add API-aanroep.
Hoe webhook gegevens worden ontvangen
De gegevens die je ontvangt, worden als een POST-parameter naar je URL verzonden. We hebben een lijst beschikbaar met alle informatie die verstuurd wordt door de webhook.
MailBlue garandeert de levering van webhooks minstens één keer. Dit betekent dat we soms een webhook meer dan eens kunnen verzenden voor een enkel evenement.
Geldige tekens en limieten voor webhooks
Je kunt alfanumerieke tekens plus de volgende speciale tekens gebruiken in je webhook-URL:
"$-_.+!*' (),"
Er zijn geen limieten aan het aantal tekens dat in een notitie of ander veld in een webhook kan worden opgenomen.
Je webhook testen
Om je webhook te testen, klik je op de knop "Verzend voorbeeldgegevens" op de pagina Instellingen > Ontwikkelaar > Webhooks in je MailBlue-account. Zodra je klikt, sturen we testgegevens naar de URL die is opgegeven in je webhook-URL-balk.