Page content

Webhooks

Gebruik maken van “Webhooks” | Een “Webhook” is een eenvoudige manier voor een programma om informatie door te geven naar andere programma’s. Dit kunnen programma’s zijn die speciaal hiervoor zijn ontwikkeld of applicaties van derden. In ActiveCampaign worden deze “Webhooks” gebruikt om gegevens te verzenden van het account naar een ander systeem of een database die beschikking heeft over een API (Application Programming Interface) die kan communiceren met “Webhooks”. “Webhooks” worden aangestuurd door handelingen die het mogelijk maken om externe programma’s bij te werken met gegevens rondom “Contacts” en activiteiten rondom campagnes.

Het is niet mogelijk om met ActiveCampaign gebruik te maken van inkomende “Webhooks”. Om dat wel te kunnen doen moet er gebruik worden gemaakt van de API van ActiveCampaign om gegevens van externe programma’s te kunnen ontvangen. Het is mogelijk om “Webhooks” te gebruiken voor het synchroniseren van gegevens met een externe database of applicatie van mensen die zich abonneren. Ook is het mogelijk om extern een lijst bij te houden met contactpersonen die zich hebben afgemeld of die zijn geweigerd voor een campagne, het aantal “clicks” kan worden bijgehouden en andere zaken rondom campagnes. In dit artikel wordt besproken waar “Webhooks” worden aangemaakt, hoe je dit kunt doen, hoe data wordt ontvangen in ActiveCampaign, hoe een “Webhook” getest kan worden en hoe je problemen kunt oplossen met “Webhooks”.

Waar worden “Webhooks” aangemaakt?

Er zijn in ActiveCampaign twee locaties waar een “Webhook” kan worden aangemaakt en ingesteld. Dit kan bij de “Developer Settings” die je kunt vinden onder “My Settings”. De “Webhook” zal dan elke keer worden aangestuurd wanneer er een specifiek aangegeven “Action” of “Event” is afgerond. De tweede mogelijkheid is met een “Webhook Automation Action”. Deze wordt alleen gebruikt als een “Contact” deze stap in een “Automation” doorloopt. Om een “Webhook Automation Action” te kunnen gebruiken hoeft er niet apart een “Webhook” te worden aangemaakt onder “Developer Settings”.

Een “Webhook” aanmaken onder “Developer Settings”

Voor elke “Webhook” die wordt aangemaakt kun je kiezen wanneer deze moet worden geactiveerd. Als je bijvoorbeeld alleen maar gegevens wilt ontvangen op het moment dat iemand een email opent of als een “Contact” wordt toegevoegd, dan kun je dit zelf instellen. Om via de “Developer Settings” een “Webhook” aan te maken kunnen de volgende stappen gevolgd worden.

1: Klik op de afbeelding naast de gebruikersnaam in ActiveCampaign en klik op “My Settings.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 1

2: Selecteer vervolgens “Developer” en klik dan op “Manage Webhooks” zoals in de afbeelding hieronder getoond wordt.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 2

3: Je komt nu op de pagina voor “Webhooks” waar je kunt kiezen voor “Add” om een “Webhook” aan te maken.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 3

4: Kies vervolgens de “List” waarmee de “Webhook” geassocieerd moet worden door een lijst te kiezen in het drop down menu. Je kunt ook kiezen voor “All Lists” om alle lijsten hiervoor te gebruiken. Type vervolgens de naam van de “Webhook” in het daarvoor bestemde veld en type de weblink van integratie of applicatie waar de gegevens naar toe gezonden moeten worden. Deze link moet afkomstig zijn van de externe applicatie of integratie die je wilt gebruiken.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 4

5: Vink vervolgens aan welke “Actions” en “Events” als “Trigger” gebruikt moeten worden voor de “Webhook”. Er kan gekozen worden uit de volgende opties:

Een “Webhook” aanmaken onder “Developer Settings” | Stap 5

6: Vink vervolgens aan welke bron er gebruikt moet worden voor het activeren van de “Webhook”. Hiervoor kun je kiezen uit de volgende mogelijkheden:

  • “Contact Action” – Wordt uitgevoerd als een “Contact” een “Action” uitvoert, bijvoorbeeld een aanmelding of het openen van een campagne.
  • “Admin User Action” – Wordt uitgevoerd als een “Admin User” een “Action” uitvoert zoals bijvoorbeeld het toevoegen aan een “Contact” aan het “Admin” gedeelte van ActiveCampaign.
  • “API” – Wordt uitgevoerd als de API in ActiveCampaign een “Action” uitvoert zoals een contactpersoon toevoegen.
  • “System Processes” – Wordt uitgevoerd als een “Automated System” een actie uitvoert zoals bijvoorbeeld het versturen van “Automation” e-mails.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 6

7: Om de instellingen af te ronden klik je vervolgens op “Add” aan de linkerzijde van het scherm onderin. In de afbeelding hieronder is een voorbeeld te zien van een “Webhook” die op deze manier wordt aangemaakt. Er wordt hierin gekozen voor het verzenden van informatie naar Zapier elk moment dat een “Contact” zich afmeldt voor een “List” via de e-mails die vanuit ActiveCampaign zijn verstuurd.

Een “Webhook” aanmaken onder “Developer Settings” | Stap 7

Een “Webhook” aanmaken in een “Automation”

Een “Webhook” aanmaken in een “Automation” kan gedaan worden onder “Conditions and Workflow” wanneer er een “Action” aan een “Automation” moet worden toegevoegd. Hiervoor kunnen de volgende stappen worden gevolgd.

  1. Klik op het “+” symbool tijdens het aanmaken of bewerken van een “Automation”.
  2. Selecteer vervolgens het tabblad “Conditions and Workflow” en kies voor de optie “Webhook” zoals in de afbeelding hieronder te zien is.

Een “Webhook” aanmaken in een “Automation” | Conditions and Workflow

  1. Vul vervolgens de weblink in die gebruikt moet worden om gegevens naar te verzenden en klik op “Save”.

De volgende “Contact” gegeven kunnen worden verzonden vanuit ActiveCampaign naar de weblink met een “Webhook Automation Action”:

  • First Name
  • Last Name
  • Email address
  • Custom fields
  • Tags
  • Organization
  • Phone number
  • Contact ID
  • IP address
  • Series ID (Automation ID)

Mogelijke karakters en beperkingen voor “Webhooks”

Het is mogelijk om gebruik te maken van alfanumerieke tekens en speciale tekens in de URL die je voor de “Webhook” wilt gebruiken. Speciale tekens die hiervoor gebruikt kunnen worden zijn:

  • $
  • _
  • .
  • +
  • !
  • *
  • (
  • )
  • ,

Er is geen limiet aan het aantal tekens dat gebruikt kan worden voor een omschrijving of ander type veld in een “Webhook”.

Een “Webhook” testen

Voor het testen van de “Webhook” klik je op “Send Sample Data” op de pagina van de betreffende “Webhook”. Er worden dan vanuit ActiveCampaign gegevens verzonden naar de URL van de “Webhook” als test.

Webhooks

Probleemoplossing voor “Webhooks

Als de “Webhook” die je hebt aangemaakt niet werkt, dan is het aan te raden om de weblink te controleren met een externe service zoals Request Catcher. Hiermee kan worden getest of de link geschikt is om gegevens te kunnen ontvangen. Als er problemen zijn met de weblink, dan raden wij aan om contact op te nemen met de ontwikkelaar van de externe applicatie die je wilt gebruiken voor de “Webhook”. Is de weblink in orde en werkt alles naar behoren, maar wordt er geen informatie ontvangen vanuit ActiveCampaign? Neem dan contact op met de ondersteuning van ActiveCampaign.

 

 

    Comment Section

    0 reacties op “Webhooks

    Plaats een reactie


    *