Olark

Olark is a live chat and AI-powered customer communication platform that enables businesses to engage website visitors in real time through chat, chatbots, WhatsApp, and SMS. The platform combines human support with CoPilot automation for capturing leads, driving sales, and providing 24/7 customer service, and is WCAG 2.1 AA accessibility certified. Olark exposes a browser-side JavaScript API for embedding and customizing the chat widget, plus webhooks and integrations with 100+ external tools.

1 APIs 0 Features

Live ChatCustomer SupportChatbotsCustomer EngagementMessagingAccessibility

APIs

Olark JavaScript API

Browser-side JavaScript API for controlling the Olark chat widget, including chatbox appearance and behavior, chat conversations, visitor information, attention grabber, greeter...

Collections

Olark JavaScript API

OPEN

GraphQL

Olark GraphQL Schema

This document describes a conceptual GraphQL schema for the Olark live chat and customer support platform. The schema is derived from the [Olark REST API](https://www.olark.com/...

GRAPHQL

Resources

👥

GitHubOrganization

API Documentation

Sources

opencollection: 1.0.0
info:
  name: Olark JavaScript API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: site_id
    value: '{{site_id}}'
    placement: query
items:
- info:
    name: Configure
    type: folder
  items:
  - info:
      name: olark.configure(key, value)
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/configure
      body:
        type: json
        data: '{}'
    docs: 'Sets a chatbox configuration value before the widget initializes.

      Example: `olark.configure(''system.hb_position'', ''left'');`.

      '
  - info:
      name: olark.identify(siteId)
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/identify
      body:
        type: json
        data: '{}'
    docs: 'Initializes the Olark chatbox with the supplied site identifier.

      Example: `olark.identify(''1234-456-78-9810'');`.

      '
- info:
    name: Box
    type: folder
  items:
  - info:
      name: api.box.show
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/box/show
    docs: api.box.show
  - info:
      name: api.box.hide
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/box/hide
    docs: api.box.hide
  - info:
      name: api.box.expand
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/box/expand
    docs: api.box.expand
  - info:
      name: api.box.shrink
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/box/shrink
    docs: api.box.shrink
  - info:
      name: api.box.setLocale
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/box/setLocale
      body:
        type: json
        data: '{}'
    docs: api.box.setLocale
- info:
    name: Chat
    type: folder
  items:
  - info:
      name: api.chat.sendMessageToVisitor
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/chat/sendMessageToVisitor
      body:
        type: json
        data: '{}'
    docs: api.chat.sendMessageToVisitor
  - info:
      name: api.chat.setOperatorGroup
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/chat/setOperatorGroup
      body:
        type: json
        data: '{}'
    docs: api.chat.setOperatorGroup
  - info:
      name: api.chat.onBeginConversation (event subscription)
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/chat/onBeginConversation
    docs: api.chat.onBeginConversation (event subscription)
- info:
    name: Visitor
    type: folder
  items:
  - info:
      name: api.visitor.getDetails
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/visitor/getDetails
    docs: api.visitor.getDetails
  - info:
      name: api.visitor.updateFullName
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/visitor/updateFullName
      body:
        type: json
        data: '{}'
    docs: api.visitor.updateFullName
  - info:
      name: api.visitor.updateEmailAddress
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/visitor/updateEmailAddress
      body:
        type: json
        data: '{}'
    docs: api.visitor.updateEmailAddress
  - info:
      name: api.visitor.updatePhoneNumber
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/visitor/updatePhoneNumber
      body:
        type: json
        data: '{}'
    docs: api.visitor.updatePhoneNumber
- info:
    name: Rules
    type: folder
  items:
  - info:
      name: api.rules.defineRule
      type: http
    http:
      method: POST
      url: https://www.olark.com/api/rules/defineRule
      body:
        type: json
        data: '{}'
    docs: api.rules.defineRule
bundled: true