Deskwoot logoDeskwoot

डेवलपर दस्तावेज़ीकरण

Deskwoot को अपने स्टैक में एकीकृत करने के लिए आपको जो कुछ भी चाहिए - चैट विजेट एम्बेड करें, या अपने बैकएंड से प्लेटफ़ॉर्म को प्रोग्रामेटिक रूप से चलाएँ।

Deskwoot API-first बनाया गया है, इसलिए जो कुछ भी आप डैशबोर्ड में कर सकते हैं वह HTTP पर भी उपलब्ध है। REST API आपको वार्तालाप बनाने और जवाब देने, संपर्कों का प्रबंधन करने, कस्टम विशेषताओं को सिंक करने, वेबहुक इवेंट सुनने और एनालिटिक्स को अपने स्वयं के BI टूल में खींचने देता है। प्रमाणीकरण एक सरल बियरर टोकन है जिसे आप सेटिंग्स → API टोकन में जनरेट करते हैं, प्रति-टोकन स्कोप के साथ ताकि आप एक रिपोर्टिंग जॉब को केवल-पढ़ने की पहुँच और अपने बैकऑफिस एकीकरण को पूर्ण पहुँच दे सकें।

JavaScript विजेट SDK आपकी वेबसाइट पर Deskwoot लाइव चैट डालने का तरीका है। यह एक एकल स्क्रिप्ट टैग और एक छोटा कॉन्फ़िग ऑब्जेक्ट है, और यह रीयल-टाइम मैसेजिंग, साइन-इन उपयोगकर्ताओं के लिए पहचान पूर्व-भरण, सक्रिय चैट ट्रिगर, CSP हार्डनिंग, फ़ाइल अनुलग्नक और AI बॉट फ़ॉलबैक को स्वचालित रूप से संभालता है। यदि आप गहरा नियंत्रण चाहते हैं - रनटाइम पर रंग बदलना, अपने स्वयं के बटन से विजेट खोलना, पृष्ठ संदर्भ ट्रैक करना - तो SDK window.$deskwoot पर एक छोटा JavaScript API प्रकट करता है।

यदि आप अभी शुरू कर रहे हैं, तो हम पहले विजेट SDK पढ़ने की सलाह देते हैं (अधिकांश टीमें इसे 10 मिनट से कम में शिप कर देती हैं) और फिर REST API पर जाने की, जब आपको CRM डेटा सिंक करना हो या अपने स्वयं के ऐप्स से टिकट निर्माण को स्वचालित करना हो।

विजेट SDK

JavaScript चैट विजेट

अपनी वेबसाइट पर Deskwoot लाइव-चैट विजेट एम्बेड करें। स्क्रिप्ट स्निपेट कॉपी-पेस्ट करें, रंग और व्यवहार कॉन्फ़िगर करें, और आगंतुकों को अपने एजेंटों तक पहुँचने दें।

  • एम्बेड स्निपेट
  • कॉन्फ़िग विकल्प
  • JavaScript API
  • पहचान पूर्व-भरण
  • CSP नोट्स
डॉक्स खोलें
REST API

HTTP API

वार्तालाप, संपर्क, इनबॉक्स, टीमों और अधिक तक प्रोग्रामेटिक पहुँच। API टोकन के साथ प्रमाणित करें और अपने बैकएंड से Deskwoot चलाएँ।

  • Auth + टोकन
  • वार्तालाप
  • संपर्क
  • इनबॉक्स
  • वेबहुक
डॉक्स खोलें

डैशबोर्ड में संबंधित

एकीकरण सतहें जिनके पास अभी तक अपना डॉक्स पृष्ठ नहीं है, सीधे आपके Deskwoot डैशबोर्ड में रहती हैं:

  • सेटिंग्स → वेबहुक - HTTP कॉलबैक के माध्यम से वार्तालाप, संदेश और संपर्क इवेंट की सदस्यता लें
  • सेटिंग्स → एकीकरण - Shopify, Stripe, WooCommerce, Slack, Zapier और अधिक के लिए वन-क्लिक कनेक्टर
  • सेटिंग्स → API टोकन - REST API के लिए स्कोप्ड टोकन बनाएँ

एक एकीकरण गायब है या किसी चीज़ को जोड़ने में मदद चाहिए? हमें hello@deskwoot.com पर संपर्क करें।

अक्सर पूछे जाने वाले प्रश्न

Deskwoot API और webhooks पर developer questions।

क्या Deskwoot में REST API है?

हाँ। Deskwoot conversations, contacts, messages, inboxes, teams, agents, labels, custom attributes, automation rules, और help center articles के लिए full REST API expose करता है। यह API official mobile app को power करती है और deskwoot.com/docs/api पर curl और JavaScript examples के साथ documented है।

API requests को authenticate कैसे करूँ?

Settings > Developer Access में एक API token generate करें। हर request में इसे Authorization header में Bearer token के रूप में pass करें। Tokens एक workspace तक scoped हैं और दूसरे tokens को प्रभावित किए बिना कभी भी revoke किए जा सकते हैं।

क्या नई conversations और messages के लिए webhooks हैं?

हाँ। Deskwoot conversation events (created, status changed, assigned, resolved) और message events (new inbound, new outbound, new private note) पर webhooks fire करता है। आप per inbox या workspace webhook URLs register करते हैं और Deskwoot हर delivery sign करता है ताकि आप source verify कर सकें।

क्या मैं Deskwoot API से custom channel बना सकता हूँ?

हाँ। REST API आपके define किए हुए किसी भी source identifier पर inbound messages accept करती है, ताकि आप mobile app में in-app chat, in-game chat, IoT devices या कोई भी custom surface integrate कर सकें। Outbound replies उसी API से route होते हैं और आपका own delivery callback trigger करते हैं।

API rate limits कहाँ मिलेंगे?

ज़्यादातर endpoints के लिए base rate limit 60 requests प्रति minute प्रति token है, bulk operations के लिए limits ज़्यादा हैं। पूरी per-endpoint table deskwoot.com/docs/api/rate-limits पर documented है। Limit hit होने पर response में Retry-After header आता है ताकि आपका client cleanly back off कर सके।

क्या OpenAPI spec या Postman collection है?

OpenAPI 3 spec deskwoot.com/docs/api/openapi.json पर published है और इसे Postman, Insomnia या किसी भी OpenAPI-compatible tool में import करके किसी भी language में clients generate किए जा सकते हैं। Spec हर release पर live API के साथ sync में रहती है।