🌐 Conradh Webhook

Tugann an Conradh Webhook deis do chóras seachtrach obairchláir a thosú i SmartFlow trí shonraí a sheoladh trí iarratais API. Tá an conradh seo oiriúnach chun SmartFlow a chomhtháthú le hiarratais tríú páirtí, ag cur ar chumas uathoibriú dinimiciúil agus gan uaim a dhéanamh ar tascanna.

---

📝 Sonraí na Conradh

Ainm: Webhook
Catagóir: Conraitheanna

---

🔧 Paraiméadair

1. URL na Conradh

• Cineál: string
• Cur Síos: Is é an URL deireadh an conradh a fhaigheann iarratais isteach. Cruthaítear é go huathoibríoch do gach obairchláir a úsáideann an conradh seo.
• Teastaíonn: Tá
• Sampla:

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

2. Lód

• Cineál: object
• Cur Síos: Is é an t-eolas a sheolann an córas seachtrach i gcorp an iarratais. D'fhéadfadh an lód seo réimsí saincheaptha a áireamh ag brath ar an gcomhoibriú.
• Teastaíonn: Tá
• Sampla:

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

3. Ceannlínte

• Cineál: object
• Cur Síos: Ceannlínte roghnach a d'fhéadfadh an córas seachtrach a áireamh le haghaidh bailíochtaithe nó cruthúnas mionsonraí.
• Teastaíonn: Níl
• Sampla:

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

---

🚀 Conas a Oibríonn sé

1. Configuráil URL na Conradh:

   • Nuair a bhíonn obairchlár á chruthú le Conradh Webhook, cruthaíonn SmartFlow URL uathúil don chonradh.
   • Comhoibrigh an URL seo leis an gcóras seachtrach chun a gcomhoibriú a chur ar bun.

2. Faigh an Eochair API:

   • Téigh chuig Socruithe ChatModel.
   • Téigh go Comhoibriú → Gréasán.
   • Cliceáil Cóip Eochair API chun an t-eochair bailíochtaithe riachtanach a fháil.

3. Struchtúr an Lóid:

   • Seolann córais sheachtraigh sonraí (lód) chuig URL na conradh ag úsáid iarratas HTTP POST.
   • Caithfidh an lód comhoiriúnacht a bheith aige leis an struchtúr a éilítear ag an obairchlár.

4. Feidhmiú na Conradh:

   • Nuair a fhaigheann an conradh iarratas bailí, gníomhóidh an obairchlár comhoiriúnach go huathoibríoch.
   • Próiseálann SmartFlow an lód, feidhmeoidh sé na gníomhartha sainithe, agus tabharfaidh sé freagra más gá.

---

💡 Cásanna Úsáide

1. Comhoibriú CRM:

   • Cás: Cruthaíonn custaiméir cuntas nua i do chóras CRM.
   • Webhook: Seolann an CRM iarratas POST chuig SmartFlow le sonraí an chustaiméara.
   • Sreabhadh Oibre: Seolann ríomhphost fáilte agus cuireann an custaiméir leis an liosta margaíochta.

2. Bainistíocht Ordú:

   • Cás: Próiseálann ardán eobharraí ordú nua.
   • Webhook: Seolann an t-ardán sonraí an ordú chuig SmartFlow.
   • Sreabhadh Oibre: Nuashonraíonn an stoc, seolann ríomhphost dearbhaithe ordú, agus tugann sé foláireamh don stór.

3. Monatóireacht ar Thionóiscí:

   • Cás: Aithníonn córas monatóireachta earráid chriticiúil.
   • Webhook: Seolann an córas foláireamh chuig SmartFlow.
   • Sreabhadh Oibre: Cruthaíonn tuairisc ar thionóisc agus tugann sé foláireamh don fhoireann innealtóireachta.

---

🔍 Sampla Configiúrtha

Iarratas Webhook atá ag Teacht

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

---

🛠️ Cleachtais is Fearr

1. Díghlasáil:

   • Déan díghlasáil ar iarratais atá ag teacht chun a chinntiú go bhfuil comhoiriúnacht sonraí agus chun mí-úsáid a chosc.
   • Úsáid clónna nó toic shlán le haghaidh bailíochtaithe.

2. Sábháilteacht Eochair API:

   • Déan cinnte go bhfuil an eochair API a fhaightear ó ChatModel Settings → Integration → Web sábháilte agus nach bhfuil sí nochtaithe go poiblí.

3. Líonadh Sonraí:

   • Léirigh go soiléir conas a bhaineann na réimsí atá ag teacht le comhoiriúnachtaí sreabhadh oibre le haghaidh próiseála gan uaim.

4. Tástáil:

   • Tástáil an webhook le payloadanna samplacha chun a chinntiú go bhfuil comhoiriúnacht agus iontaofacht ann.

5. Láimhseáil Earráidí:

   • Configir sreafa oibre chun láimhseáil a dhéanamh ar shonraí atá in easnamh nó atá mí-oiriúnach go grámhar.

---

📊 Monatóireacht agus Dífhoirmiú

• Lóg Gníomhaíochta:
  Rian a choinneáil ar iarratais webhook atá ag teacht agus a stádas próiseála i dtaobh SmartFlow.

• Tuairisciú Earráidí:
  Aithin iarratais a theip agus féach ar shonraí earráidí le haghaidh réitigh.

---

Soláthraíonn an chuid seo treoir mhionsonraithe do Thréith Webhook, ag cinntiú go bhfuil sé éasca do úsáideoirí é a chomhtháthú ina sreafa oibre. Inis dom más gá duit aon chobhsaitheachtaí!