🌐 Webhook Trigger

Webhook Trigger möjliggör för externa system att initiera arbetsflöden i SmartFlow genom att skicka data via API-förfrågningar. Denna trigger är idealisk för att integrera SmartFlow med tredjepartsapplikationer, vilket möjliggör dynamisk och sömlös automatisering av uppgifter.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Slutpunkts-URL:en för webhooken att ta emot inkommande förfrågningar. Denna genereras automatiskt för varje arbetsflöde som använder denna trigger.
• Required: Ja
• Example:

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

2. Payload

• Type: object
• Description: Den data som skickas av det externa systemet i förfrågningskroppen. Denna payload kan inkludera anpassade fält beroende på integrationen.
• Required: Ja
• Example:

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

3. Headers

• Type: object
• Description: Valfria rubriker som det externa systemet kan inkludera för autentisering eller metadataändamål.
• Required: Nej
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • När du skapar ett arbetsflöde med en Webhook Trigger genererar SmartFlow en unik URL för webhooken.
   • Dela denna URL med det externa systemet för att konfigurera deras integration.

2. API Key Retrieval:

   • Navigera till ChatModel Settings.
   • Gå till Integration → Web.
   • Klicka på Copy API Key för att hämta den nödvändiga autentiseringstoken.

3. Payload Structure:

   • Externa system skickar data (payload) till webhook-URL:en med en HTTP POST-förfrågan.
   • Payloaden måste matcha den struktur som krävs av arbetsflödet.

4. Trigger Execution:

   • När webhooken tar emot en giltig förfrågan utlöses det associerade arbetsflödet automatiskt.
   • SmartFlow bearbetar payloaden, utför definierade åtgärder och returnerar ett svar om det behövs.

---

💡 Användningsfall

1. CRM-integration:

   • Scenario: En kund skapar ett nytt konto i ditt CRM-system.
   • Webhook: CRM-systemet skickar en POST-begäran till SmartFlow med kundens uppgifter.
   • Workflow: Skickar ett välkomstmejl och lägger till kunden i din marknadsföringslista.

2. Orderhantering:

   • Scenario: En e-handelsplattform behandlar en ny beställning.
   • Webhook: Plattformen skickar beställningsuppgifter till SmartFlow.
   • Workflow: Uppdaterar lagret, skickar en orderbekräftelse via e-post och meddelar lagret.

3. Incidentövervakning:

   • Scenario: Ett övervakningssystem upptäcker ett kritiskt fel.
   • Webhook: Systemet skickar en varning till SmartFlow.
   • Workflow: Skapar en incidentrapport och meddelar ingenjörsteamet.

---

🔍 Exempelkonfiguration

Inkommande Webhook-begäran

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"
}

---

🛠️ Bästa praxis

1. Validering:

   • Validera inkommande begärningar för att säkerställa dataintegritet och förhindra missbruk.
   • Använd säkra headers eller tokens för autentisering.

2. API-nyckelsäkerhet:

   • Se till att API-nyckeln som hämtas från ChatModel Settings → Integration → Web hålls säker och inte exponeras offentligt.

3. Datakartläggning:

   • Kartlägg tydligt inkommande fält till arbetsflödesvariabler för smidig bearbetning.

4. Testning:

   • Testa webhooken med exempelpayloads för att säkerställa kompatibilitet och tillförlitlighet.

5. Felhantering:

   • Konfigurera arbetsflöden för att hantera saknade eller felaktiga data på ett smidigt sätt.

---

📊 Övervakning och felsökning

• Aktivitetsloggar:
  Spåra inkommande webhook-begärningar och deras bearbetningsstatus i SmartFlows instrumentpanel.

• Felrapportering:
  Identifiera misslyckade begärningar och se feluppgifter för felsökning.

---

Detta avsnitt ger en detaljerad guide för Webhook Trigger, vilket säkerställer att användarna kan integrera den sömlöst i sina arbetsflöden. Låt mig veta om du behöver några justeringar!