🌐 Webhook Trigger

De Webhook Trigger stelt externe systemen in staat om workflows in SmartFlow te starten door gegevens te verzenden via API-aanvragen. Deze trigger is ideaal voor het integreren van SmartFlow met applicaties van derden, waardoor dynamische en naadloze automatisering van taken mogelijk is.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: De endpoint-URL voor de webhook om binnenkomende verzoeken te ontvangen. Dit wordt automatisch gegenereerd voor elke workflow die deze trigger gebruikt.
• Required: Ja
• Example:

  https://api.smartflow.com/webhooks/{workflowId}

2. Payload

• Type: object
• Description: De gegevens die door het externe systeem in de verzoekbody worden verzonden. Deze payload kan aangepaste velden bevatten, afhankelijk van de integratie.
• Required: Ja
• Example:

  {
    "event": "order_created",
    "orderId": "12345",
    "customer": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }

3. Headers

• Type: object
• Description: Optionele headers die het externe systeem mogelijk kan opnemen voor authenticatie of metadata doeleinden.
• Required: Nee
• Example:

  {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
  }

🚀 Hoe Het Werkt

1. Webhook URL Configuratie:

   • Bij het maken van een workflow met een Webhook Trigger genereert SmartFlow een unieke URL voor de webhook.
   • Deel deze URL met het externe systeem om hun integratie te configureren.

2. API Sleutel Ophalen:

   • Navigeer naar ChatModel Instellingen.
   • Ga naar Integratie → Web.
   • Klik op Kopieer API Sleutel om de benodigde authenticatietoken op te halen.

3. Payload Structuur:

   • Externe systemen sturen gegevens (payload) naar de webhook URL met een HTTP POST verzoek.
   • De payload moet overeenkomen met de structuur die door de workflow vereist is.

4. Trigger Uitvoering:

   • Wanneer de webhook een geldig verzoek ontvangt, wordt de bijbehorende workflow automatisch geactiveerd.
   • SmartFlow verwerkt de payload, voert gedefinieerde acties uit en retourneert een antwoord indien nodig.

💡 Gebruikscasussen

1. CRM-integratie:

   • Scenario: Een klant maakt een nieuw account aan in uw CRM-systeem.
   • Webhook: De CRM stuurt een POST-verzoek naar SmartFlow met klantgegevens.
   • Workflow: Stuurt een welkomst-e-mail en voegt de klant toe aan uw marketinglijst.

2. Orderbeheer:

   • Scenario: Een e-commerceplatform verwerkt een nieuwe bestelling.
   • Webhook: Het platform stuurt bestelgegevens naar SmartFlow.
   • Workflow: Werkt de voorraad bij, stuurt een orderbevestiging per e-mail en meldt het magazijn.

3. Incidentmonitoring:

   • Scenario: Een monitoringsysteem detecteert een kritieke fout.
   • Webhook: Het systeem stuurt een waarschuwing naar SmartFlow.
   • Workflow: Maakt een incidentrapport aan en informeert het engineeringteam.

🔍 Voorbeeldconfiguratie

Binnenkomende Webhook Verzoek

URL:

https://api.smartflow.com/webhooks/abc123

Payload:

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Headers:

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

🛠️ Beste Praktijken

1. Validatie:

   • Valideer binnenkomende verzoeken om de dataintegriteit te waarborgen en misbruik te voorkomen.
   • Gebruik veilige headers of tokens voor authenticatie.

2. API Sleutel Beveiliging:

   • Zorg ervoor dat de API-sleutel die is opgehaald uit ChatModel Settings → Integration → Web veilig wordt bewaard en niet openbaar wordt gemaakt.

3. Gegevensmapping:

   • Map binnenkomende velden duidelijk naar workflowvariabelen voor naadloze verwerking.

4. Testen:

   • Test de webhook met voorbeeldpayloads om compatibiliteit en betrouwbaarheid te waarborgen.

5. Foutafhandeling:

   • Configureer workflows om ontbrekende of verkeerd gevormde gegevens op een nette manier af te handelen.

📊 Monitoring en Debugging

• Activiteitenlogboeken:
  Volg binnenkomende webhookverzoeken en hun verwerkingsstatus in het dashboard van SmartFlow.

• Foutrapportage:
  Identificeer mislukte verzoeken en bekijk foutdetails voor probleemoplossing.

---

Deze sectie biedt een gedetailleerde gids voor de Webhook Trigger, zodat gebruikers deze naadloos in hun workflows kunnen integreren. Laat het me weten als je nog aanpassingen nodig hebt!