openapi: 3.1.0
info:
  title: Olark JavaScript Box Configure API
  description: 'Olark exposes a browser-side JavaScript API for embedding and controlling

    the Olark live-chat widget. It is not a server REST API; this OpenAPI

    document describes the JavaScript API surface as documented at

    https://www.olark.com/api by treating each `olark(''api.<area>.<method>'')`

    invocation as a logical operation under a synthetic `/api/...` path so

    that the contract can be navigated alongside conventional REST APIs.

    Authentication is performed client-side via the Olark site identifier

    passed to `olark.identify(siteId)`.

    '
  version: 1.0.0
  contact:
    name: Olark
    url: https://www.olark.com/api
servers:
- url: https://www.olark.com/api
  description: Olark JavaScript API documentation host (logical base for this spec)
security:
- OlarkSiteId: []
tags:
- name: Configure
  description: Pre-load configuration
paths:
  /configure:
    post:
      tags:
      - Configure
      summary: olark.configure(key, value)
      description: 'Sets a chatbox configuration value before the widget initializes.

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

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - key
              - value
              properties:
                key:
                  type: string
                value: {}
      responses:
        '200':
          description: Configuration applied (client-side)
  /identify:
    post:
      tags:
      - Configure
      summary: olark.identify(siteId)
      description: 'Initializes the Olark chatbox with the supplied site identifier.

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

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - siteId
              properties:
                siteId:
                  type: string
      responses:
        '200':
          description: Identified (client-side)
components:
  securitySchemes:
    OlarkSiteId:
      type: apiKey
      in: query
      name: site_id
      description: 'Olark identifies an installation via a public site identifier

        (e.g. `1234-456-78-9810`) passed client-side to `olark.identify()`.

        It is not a secret and is included here only to make the

        identification mechanism explicit in the OpenAPI contract.

        '