Jump to Content
Kustomer Chat SDKsAbout Kustomer Chat SDKsWeb SDKiOS SDKAndroid SDKReact Native SDK
GuidesChangelog
About Kustomer Chat SDKsWeb SDKiOS SDKAndroid SDKReact Native SDKLog InKustomer Help CenterKustomer Chat SDKs
Guides
Log InKustomer Help Center
GuidesChangelog

Get started

  • Requirements
  • Installation
  • Troubleshooting

Embed Kustomer Chat

  • Add chat to your knowledge base
  • Add chat to your website

Use the Chat Web SDK

  • Overview: Web SDK
  • Log in and authentication
  • Customize chat
  • Load chat asynchronously
  • Start chat with a custom button
  • Read receipts
  • Localization
  • Handing off conversations within Kustomer Chat
  • Customizing Link Previews with URL Unfurling

Chat UI API reference

  • Overview: Chat UI API methods
  • Kustomer.start()
  • Kustomer.stop()
  • Kustomer.open()
  • Kustomer.close()
  • Kustomer.login()
  • Kustomer.logout()
  • Kustomer.describeCustomer()
  • Kustomer.describeConversation()
  • Kustomer.addListener()
  • Kustomer.removeListener()
  • Kustomer.isChatAvailable()
  • Kustomer.createConversation()
  • Kustomer.openConversationById()
  • Kustomer.getOpenConversations()
  • Kustomer.openKbArticle()
  • Kustomer.openKbCategory()
  • Kustomer.getUnreadCount()

Build Your Own UI

  • Build your own UI
  • Message template types
  • Core API Reference
    • KustomerCore.init()
    • KustomerCore.createConversation()
    • KustomerCore.addListener()
    • KustomerCore.removeListener()
    • KustomerCore.sendMessage()
    • KustomerCore.getConversations()
    • KustomerCore.getMessages()
    • KustomerCore.getHistoricalMessages()
    • KustomerCore.markRead()
    • KustomerCore.getUnreadCount()
    • KustomerCore.isChatAvailable()
    • KustomerCore.endConversation()
    • KustomerCore.initAssistant()
    • KustomerCore.submitSatisfactionForm()
    • KustomerCore.sendTypingActivity()
    • KustomerCore.login()
    • KustomerCore.logout()
    • KustomerCore.describeCustomer()
    • KustomerCore.describeConversation()
    • KustomerCore.getCategories()
    • KustomerCore.getArticles()
    • KustomerCore.getArticleById()
    • KustomerCore.searchArticles()
    • KustomerCore.isUrlAllowed()
    • KustomerCore.sendPresenceActivity()
    • KustomerCore.getChatSettings()
    • KustomerCore.getKnowledgeBaseConfig()
    • KustomerCore.submitArticleFeedback()
    • KustomerCore.updateArticleFeedback()

Requirements

Learn about the requirements for the Kustomer chat web SDK.

    • Kustomer platform permissions
    • Browser requirements
    • Generate a Kustomer API Key
      • Auto-generate the API key
      • Manually generate the API key
    • Allow domains
    • Turn on chat settings in Kustomer