इनबाउंड और एकीकरण ट्रिगर्स

curl https://your-aihummer.example/v1/inbound/generic \
  -H "X-AIHummer-Inbound-Secret: $AIHUMMER_INBOUND_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "external_id": "ticket-4821",
    "text": "A customer asks whether order #4821 has shipped."
  }'

curl https://your-aihummer.example/v1/integrations/trigger \
  -H "Authorization: Bearer $AIHUMMER_INBOUND_TRIGGER_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "zapier",
    "external_id": "lead-99",
    "text": "New lead captured from the contact form."
  }'

# Subscribe from the beginning
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>"

# Resume after a known cursor
curl -N -H "Authorization: Bearer ah-..." \
  "https://your-aihummer.example/v1/events/stream?workspace_id=<id>&since=<cursor>"

OpenAI-संगत API के अलावा, AiHummer स्वीकार करता है **इनबाउंड संदेश** कनेक्टर्स और ऑटोमेशन प्लेटफ़ॉर्म से, और उत्सर्जित करता है **सर्वर-साइड ईवेंट स्ट्रीम** आप सदस्यता ले सकते हैं। ये एंडपॉइंट्स बाहरी सिस्टम गेटवे को कार्य कैसे भेजते हैं और यूआई कैसे लाइव रहते हैं, यह दर्शाते हैं। ## इनबाउंड एंडपॉइंट्स इनबाउंड एंडपॉइंट्स वह हैं जिनके माध्यम से चैनल कनेक्टर्स और कस्टम इंटीग्रेशन संदेश को टर्न इंजन तक पहुँचाते हैं। इन्हें एक द्वारा सुरक्षित किया जाता है **एचएमएसी साझा रहस्य** भेजा गया `X-AIHummer-Inbound-Secret` हेडर (द `AIHUMMER_INBOUND_SECRET` settings-catalog कुंजी — व्यवस्थापक UI में Management → Settings के अंतर्गत कॉन्फ़िगर किया गया या इसके साथ `aihummer settings set`में नहीं `gateway.env`). | विधि और पथ | उद्देश्य | |---|---| | `POST /v1/inbound/telegram` | नेटिव टेलीग्राम इनबाउंड पेलोड्स | | `POST /v1/inbound/generic` | ईमेल→वेबहुक, क्रोन और कस्टम ऐप्स के लिए सामान्य इनबाउंड | | `POST /v1/inbound/binding/status` | चैनल-बिंडिंग स्थिति रिपोर्ट करें | द **सामान्य** एंडपॉइंट किसी भी स्रोत को AiHummer में भेजने का सबसे सरल तरीका है। चैनल नाम, एक स्थिर बाहरी पहचानकर्ता और संदेश पाठ के साथ एक छोटा JSON बॉडी भेजें: ```bash curl https://your-aihummer.example/v1/inbound/generic \ -H "X-AIHummer-Inbound-Secret: $AIHUMMER_INBOUND_SECRET" \ -H "Content-Type: application/json" \ -d '{ "channel": "email", "external_id": "ticket-4821", "text": "A customer asks whether order #4821 has shipped." }' ``` > [!NOTE] > सामान्य इनबाउंड डिस्पैचर को एक डिफ़ॉल्ट कार्यक्षेत्र की आवश्यकता होती है। सेट करें > `AIHUMMER_DEFAULT_WORKSPACE_ID` तो इनबाउंड संदेशों को रूट किया जा सकता है। > [!WARNING] > इनबाउंड एंडपॉइंट किसी द्वारा सुरक्षित नहीं हैं `ah-` एपीआई कुंजी — वे उस पर निर्भर करते हैं > `X-AIHummer-Inbound-Secret` HMAC। उस रहस्य को क्लाइंट-साइड कोड से दूर रखें और > अगर यह रिसता है तो इसे घुमाएं। ## इंटीग्रेशन ट्रिगर्स (ज़ैपियर / मेक) `POST /v1/integrations/trigger` लो-कोड ऑटोमेशन प्लेटफ़ॉर्म के लिए प्रवेश बिंदु है जैसे **ज़ैपियर** और **बनाना**. अंतिम बिंदु है **डिफ़ॉल्ट रूप से अक्षम**: तक `AIHUMMER_INBOUND_TRIGGER_SECRET` सेटिंग कॉन्फ़िगर होने पर यह प्रतिक्रिया करता है **`501 Not Implemented`**. यह एक है **अलग** गुप्त, अलग `AIHUMMER_INBOUND_SECRET`; जैसे हर settings-catalog कुंजी, यह एडमिन UI (प्रबंधन → सेटिंग्स) में या के साथ सेट किया गया है `aihummer settings set`. एक बार कॉन्फ़िगर होने के बाद, एंडपॉइंट किसी एक को स्वीकार करता है `X-AIHummer-Signature` HMAC या इस रूप का बियरर टोकन `Authorization: Bearer <the AIHUMMER_INBOUND_TRIGGER_SECRET value>`. ```bash curl https://your-aihummer.example/v1/integrations/trigger \ -H "Authorization: Bearer $AIHUMMER_INBOUND_TRIGGER_SECRET" \ -H "Content-Type: application/json" \ -d '{ "channel": "zapier", "external_id": "lead-99", "text": "New lead captured from the contact form." }' ``` ## Admin Sessions बैकएंड ये दोनों रूट **Admin Sessions** पेज के लिए बनाए रखे गए आंतरिक ट्रांसपोर्ट हैं। ये ग्राहक के लिए समर्थित एम्बेड करने योग्य चैनल नहीं हैं। | विधि और पथ | उद्देश्य | |---|---| | `POST /v1/web/session` | Admin Sessions वार्तालाप खोलें या दोबारा जोड़ें | | `GET /v1/web/stream` | वार्तालाप का उत्तर SSE के रूप में स्ट्रीम करें | ## घटना धारा `GET /v1/events/stream` है **पुनः आरंभ योग्य** गेटवे घटनाओं का सर्वर-सेंट इवेंट्स फीड। इस एंडपॉइंट की दो सख्त आवश्यकताएँ हैं: 1. **द `?workspace_id=<id>` पैरामीटर अनिवार्य है** — इसके बिना अनुरोध के साथ अस्वीकृत किया गया `400`एक किरायेदार गार्ड यह सत्यापित करता है कि कार्यस्थान का स्वामित्व कॉलर का किरायेदार; किसी और का `workspace_id` उपज `403`. 2. **प्रमाणीकरण आवश्यक है** — एक व्यवस्थापक सत्र (कुकी) या एक `ah-` एपीआई एक में कुंजी `Authorization: Bearer` हेडर। इसके बिना प्रतिक्रिया है `401`. पास ए `?since=` कर्सर को वहीं से पुनः शुरू करना जहाँ पिछला कनेक्शन रुका था, ताकि पुनः कनेक्ट करने पर कोई इवेंट न खोए। ```bash # Subscribe from the beginning curl -N -H "Authorization: Bearer ah-..." \ "https://your-aihummer.example/v1/events/stream?workspace_id=<id>" # Resume after a known cursor curl -N -H "Authorization: Bearer ah-..." \ "https://your-aihummer.example/v1/events/stream?workspace_id=<id>&since=<cursor>" ``` > [!TIP] > प्रत्येक घटना द्वारा लाए गए मूल्य को अगले के रूप में मानें `since` कर्सर। चालू > पुनः कनेक्ट करें, उस कर्सर से फिर से चलाएँ ताकि आपके लिए कम से कम एक बार डिलीवरी की गारंटी दी जा सके > उपभोक्ता। ## अगला कहाँ - टेक्स्ट OpenAI सतह पर पलटता है: [चैट पूर्णताएँ](/hi/v1.0/api/chat-completions). - डिवाइस पेयरिंग, SSO फेडरेशन और प्रोटोकॉल सतहें: [वेबहुक्स, एससीआईएम और पेयरिंग](/hi/v1.0/api/webhooks-scim-pairing). - सभी `AIHUMMER_*` नॉब्स: [पर्यावरण चर](/hi/v1.0/reference/env-vars).