🌐 Webhook Trigger

Webhook Trigger gjør det mulig for eksterne systemer å initiere arbeidsflyter i SmartFlow ved å sende data via API-forespørsler. Denne triggeren er ideell for å integrere SmartFlow med tredjepartsapplikasjoner, noe som muliggjør dynamisk og sømløs automatisering av oppgaver.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Endepunkt-URL-en for webhooken for å motta innkommende forespørsel. Denne genereres automatisk for hver arbeidsflyt som bruker denne triggeren.
• Required: Ja
• Example:

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

2. Payload

• Type: object
• Description: Dataene sendt av det eksterne systemet i forespørselens kropp. Denne payloaden kan inkludere tilpassede felt avhengig av integrasjonen.
• Required: Ja
• Example:

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

3. Headers

• Type: object
• Description: Valgfri overskrifter som det eksterne systemet kan inkludere for autentisering eller metadataformål.
• Required: Nei
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Når du oppretter en arbeidsflyt med en Webhook Trigger, genererer SmartFlow en unik URL for webhooken.
   • Del denne URL-en med det eksterne systemet for å konfigurere deres integrasjon.

2. API Key Retrieval:

   • Naviger til ChatModel Settings.
   • Gå til Integration → Web.
   • Klikk Copy API Key for å hente den nødvendige autentiseringstokenen.

3. Payload Structure:

   • Eksterne systemer sender data (payload) til webhook-URL-en ved å bruke en HTTP POST forespørsel.
   • Payloaden må samsvare med strukturen som kreves av arbeidsflyten.

4. Trigger Execution:

   • Når webhooken mottar en gyldig forespørsel, utløses den tilknyttede arbeidsflyten automatisk.
   • SmartFlow behandler payloaden, utfører definerte handlinger og returnerer et svar om nødvendig.

---

💡 Bruksområder

1. CRM-integrasjon:

   • Scenario: En kunde oppretter en ny konto i CRM-systemet ditt.
   • Webhook: CRM-en sender en POST-forespørsel til SmartFlow med kundedetaljer.
   • Workflow: Sender en velkomst-e-post og legger kunden til i markedsføringslisten din.

2. Ordrehåndtering:

   • Scenario: En e-handelsplattform behandler en ny bestilling.
   • Webhook: Plattformen sender bestillingsdetaljer til SmartFlow.
   • Workflow: Oppdaterer lagerbeholdningen, sender en bestillingsbekreftelses-e-post og varsler lageret.

3. Hendelsessporing:

   • Scenario: Et overvåkingssystem oppdager en kritisk feil.
   • Webhook: Systemet sender et varsel til SmartFlow.
   • Workflow: Oppretter en hendelsesrapport og varsler ingeniørteamet.

---

🔍 Eksempelkonfigurasjon

Innkommende Webhook-forespørsel

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 praksis

1. Validering:

   • Valider innkommende forespørsel for å sikre dataintegritet og forhindre misbruk.
   • Bruk sikre headere eller tokens for autentisering.

2. API-nøkkel sikkerhet:

   • Sørg for at API-nøkkelen hentet fra ChatModel Settings → Integration → Web holdes sikker og ikke eksponeres offentlig.

3. Datakartlegging:

   • Kartlegg tydelig innkommende felt til workflow-variabler for sømløs behandling.

4. Testing:

   • Test webhooken med eksempel-payloads for å sikre kompatibilitet og pålitelighet.

5. Feilhåndtering:

   • Konfigurer workflows for å håndtere manglende eller feilaktige data på en elegant måte.

---

📊 Overvåking og feilsøking

• Aktivitetslogger:
  Spor innkommende webhook-forespørsel og deres behandlingsstatus i SmartFlows dashbord.

• Feilrapportering:
  Identifiser mislykkede forespørsel og se feildetaljer for feilsøking.

---

Denne seksjonen gir en detaljert veiledning for Webhook Trigger, og sikrer at brukere kan integrere den sømløst i sine arbeidsflyter. Gi meg beskjed hvis du trenger noen forbedringer!