Liigu peamise sisu juurde

🌐 Webhook Trigger

Webhook Trigger võimaldab välistel süsteemidel alustada töövooge SmartFlow's API päringute kaudu andmete saatmise teel. See käivitaja on ideaalne SmartFlow integreerimiseks kolmandate osapoolte rakendustega, võimaldades dünaamilist ja sujuvat ülesannete automatiseerimist.

pasted-image.png

📝 Trigger Details​

Name: Webhook
Category: Triggers

🔧 Parameetrid​

1. Webhook URL​

  • Tüüp: string
  • Kirjeldus: Lõpp-punkti URL webhooki jaoks, et vastu võtta sissetulevaid päringuid. See genereeritakse automaatselt iga töövoo jaoks, mis kasutab seda käivitajat.
  • Nõutav: Jah
  • Näide: 
    https://api.smartflow.com/webhooks/{workflowId}

2. Payload​

  • Tüüp: object
  • Kirjeldus: Andmed, mida väline süsteem saadab päringu kehas. See payload võib sisaldada kohandatud välju sõltuvalt integratsioonist.
  • Nõutav: Jah
  • Näide: 
    {
      "event": "order_created",
      "orderId": "12345",
      "customer": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }

3. Pealkirjad​

  • Tüüp: object
  • Kirjeldus: Valikulised pealkirjad, mida väline süsteem võib sisaldada autentimise või metaandmete eesmärkidel.
  • Nõutav: Ei
  • Näide: 
    {
      "Authorization": "Bearer your-api-key",
      "Content-Type": "application/json"
    }

🚀 Kuidas See Toimib​

  1. Webhooki URL-i Konfigureerimine:

    • Kui loote töövoo Webhooki Käivitajaga, genereerib SmartFlow unikaalse URL-i webhooki jaoks.
    • Jagage seda URL-i välise süsteemiga, et konfigureerida nende integreerimist.

  2. API Võtme Saamine:

    • Liikuge ChatModel Seaded.
    • Minge Integreerimine → Web.
    • Klõpsake Kopeeri API Võti, et saada vajalik autentimisvõti.

  3. Payload Struktuur:

    • Välised süsteemid saadavad andmeid (payload) webhooki URL-ile, kasutades HTTP POST päringut.
    • Payload peab vastama töövoo nõutud struktuurile.

  4. Käivitamise Täitmine:

    • Kui webhook saab kehtiva päringu, käivitatakse automaatselt seotud töövoog.
    • SmartFlow töötleb payload'i, täidab määratud toimingud ja tagastab vajadusel vastuse.

💡 Kasutuse juhtumid​

  1. CRM Integreerimine:

    • Stsenaarium: Klient loob teie CRM-süsteemis uue konto.
    • Webhook: CRM saadab POST päringu SmartFlow'le kliendiandmetega.
    • Töövoog: Saadab tervituse e-kirja ja lisab kliendi teie turundusloendisse.

  2. Tellimuste Halduse:

    • Stsenaarium: E-kaubanduse platvorm töötleb uut tellimust.
    • Webhook: Platvorm saadab tellimuse andmed SmartFlow'le.
    • Töövoog: Uuendab laoseisu, saadab tellimuse kinnituse e-kirja ja teavitab ladu.

  3. Intsidentide Jälgimine:

    • Stsenaarium: Jälgimissüsteem tuvastab kriitilise vea.
    • Webhook: Süsteem saadab SmartFlow'le häire.
    • Töövoog: Loob intsidentide aruande ja teavitab insenerimeeskonda.

🔍 Näidis Konfiguratsioon​

Sissetulev Webhooki Päring​

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

🛠️ Parimad Tavad​

  1. Valideerimine:

    • Valideeri sissetulevaid päringuid, et tagada andmete terviklikkus ja vältida väärkasutust.
    • Kasuta autentimiseks turvalisi päiseid või tokene.

  2. API Võtme Turvalisus:

    • Veendu, et ChatModel Settings → Integration → Web kaudu saadud API võti on hoitud turvaliselt ja ei ole avalikult nähtav.

  3. Andmete Kaardistamine:

    • Kaardista selgelt sissetulevad väljad töövoo muutujate jaoks sujuvaks töötlemiseks.

  4. Testimine:

    • Testi veebipunkti näidiskoormustega, et tagada ühilduvus ja usaldusväärsus.

  5. Viga Käsitlemine:

    • Konfigureeri töövood, et need käsitleksid puuduvat või valesti vormindatud andmeid sujuvalt.

📊 Jälgimine ja tõrkeotsing​

  • Tegevuslogid:
    Jälgige sissetulevaid webhooki päringuid ja nende töötlemise staatust SmartFlow'i armatuurlaud.

  • Vigade raport:
    Tuvastage ebaõnnestunud päringud ja vaadake tõrke üksikasju tõrkeotsinguks.

See jaotis pakub üksikasjalikku juhendit Webhook Triggeri jaoks, tagades, et kasutajad saavad selle sujuvalt oma töövoogudesse integreerida. Andke teada, kui vajate mingeid täiendusi!