Service Types

LibraryH3lp supports a variety of web chat widget behaviors, which we call service types. You can embed a widget directly in a page, float a widget above a page, or pop out a widget into a separate browser window. Which type you choose to use depends on your application. And you can opt to use more than one service type throughout your web site. To help you navigate service types, we've compiled a list of pros and cons for each of the types.

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Service Type List Resource

Resource URI

/2011-12-03/service-types

Service Type Properties

A service type is represented by the following properties:

Property Description
id Unique integer identifier for a service type.
name A string representation of the service type. Possible values are embedded, pop-up, and follow-me.

HTTP GET

Returns a JSON response containing a list of service types.

Example

GET /2011-12-03/service-types

[
  {
    "id": 1,
    "name": "embedded",
  },
  {
    "id": 2,
    "name": "pop-up",
  },
  {
    "id": 3,
    "name": "follow-me",
  }
]

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.