🌐 Webhook Trigger

Webhook Trigger mahdollistaa ulkoisten järjestelmien käynnistää työnkulkuja SmartFlow'ssa lähettämällä tietoja API-pyyntöjen kautta. Tämä triggeri on ihanteellinen SmartFlow'n integroimiseksi kolmansien osapuolten sovelluksiin, mahdollistaen dynaamisen ja saumattoman automaation tehtävissä.

---

📝 Trigger Details

Name: Webhook
Category: Triggers

---

🔧 Parameters

1. Webhook URL

• Type: string
• Description: Päätepisteen URL webhookille, joka vastaanottaa saapuvat pyynnöt. Tämä luodaan automaattisesti jokaiselle työnkululle, joka käyttää tätä triggeriä.
• Required: Kyllä
• Example:

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

2. Payload

• Type: object
• Description: Ulkoisen järjestelmän lähettämä data pyyntöruumissa. Tämä payload voi sisältää mukautettuja kenttiä integraatiosta riippuen.
• Required: Kyllä
• Example:

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

3. Headers

• Type: object
• Description: Valinnaiset otsikot, joita ulkoinen järjestelmä saattaa sisällyttää todennusta tai metatietoja varten.
• Required: Ei
• Example:

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

---

🚀 How It Works

1. Webhook URL Configuration:

   • Kun luot työnkulkua Webhook Triggerin kanssa, SmartFlow luo ainutlaatuisen URL-osoitteen webhookille.
   • Jaa tämä URL ulkoisen järjestelmän kanssa heidän integraationsa määrittämiseksi.

2. API Key Retrieval:

   • Siirry kohtaan ChatModel Settings.
   • Mene kohtaan Integration → Web.
   • Napsauta Copy API Key saadaksesi tarvittavan todennustokenin.

3. Payload Structure:

   • Ulkoiset järjestelmät lähettävät dataa (payload) webhook URL:lle käyttäen HTTP POST -pyyntöä.
   • Payloadin on vastattava työnkulun vaatimuksia.

4. Trigger Execution:

   • Kun webhook vastaanottaa voimassa olevan pyynnön, siihen liittyvä työnkulku käynnistyy automaattisesti.
   • SmartFlow käsittelee payloadin, suorittaa määritellyt toiminnot ja palauttaa vastauksen tarvittaessa.

---

💡 Käyttötapaukset

1. CRM-integraatio:

   • Skenaario: Asiakas luo uuden tilin CRM-järjestelmäänne.
   • Webhook: CRM lähettää POST-pyynnön SmartFlow'lle asiakastietojen kanssa.
   • Työnkulku: Lähettää tervetuloviestin ja lisää asiakkaan markkinointilistalle.

2. Tilausten hallinta:

   • Skenaario: Verkkokauppa käsittelee uuden tilauksen.
   • Webhook: Alusta lähettää tilauksen tiedot SmartFlow'lle.
   • Työnkulku: Päivittää varaston, lähettää tilausvahvistussähköpostin ja ilmoittaa varastolle.

3. Tapahtumien seuranta:

   • Skenaario: Seurantajärjestelmä havaitsee kriittisen virheen.
   • Webhook: Järjestelmä lähettää hälytyksen SmartFlow'lle.
   • Työnkulku: Luo tapahtumaraportin ja ilmoittaa insinööriryhmälle.

---

🔍 Esimerkkikonfiguraatio

Saapuva Webhook-pyyntö

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

---

🛠️ Parhaat käytännöt

1. Validointi:

   • Varmista saapuvien pyyntöjen validointi tietojen eheyden varmistamiseksi ja väärinkäytön estämiseksi.
   • Käytä turvallisia otsikoita tai tokeneita todennukseen.

2. API-avaimen turvallisuus:

   • Varmista, että ChatModel Settings → Integration → Web -kohdasta saatu API-avain pidetään turvassa eikä sitä paljasteta julkisesti.

3. Tietojen kartoitus:

   • Kartoituksen saapuvat kentät selkeästi työnkulun muuttujille sujuvan käsittelyn varmistamiseksi.

4. Testaus:

   • Testaa webhookia esimerkkipayloadilla yhteensopivuuden ja luotettavuuden varmistamiseksi.

5. Virheiden käsittely:

   • Konfiguroi työnkulut käsittelemään puuttuvia tai virheellisiä tietoja sujuvasti.

---

📊 Seuranta ja vianetsintä

• Toimintalokit:
  Seuraa saapuvia webhook-pyyntöjä ja niiden käsittelytilaa SmartFlow'n hallintapaneelissa.

• Virheraportointi:
  Tunnista epäonnistuneet pyynnöt ja tarkastele virhetietoja vianetsintää varten.

---

Tämä osio tarjoaa yksityiskohtaisen oppaan Webhook Triggerille, varmistaen, että käyttäjät voivat integroida sen saumattomasti työnkulkuihinsa. Ilmoita, jos tarvitset hienosäätöjä!