Skip to content
This repository has been archived by the owner on Jan 19, 2022. It is now read-only.
/ humany-docs Public archive

Technical documentation on humany API, widgets and integration

License

Notifications You must be signed in to change notification settings

Humany/humany-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NOTE: This is widgets V4 documentation. Widgets V3 documentation. Information about widget versions.

Humany Technical Documentation

Technical documentation on humany API, widgets and integration options

Overview

Humany supports a number of integration options. Depending on your use case you may prefer to use specialized plugins, a more general plugin API, direct REST integration or webhook actions.

Another consideration is type of interface being targeted. There are two main types of interface widgets - conversational and view-based.

View Based Widgets (Inline and Floating)

The following picture describes the relation between API options in a view-based widget such as inline or floating.

API Overview

Conversational Widgets (Bot)

The following picture describes the relation between API options in the bot conversational widget.

API Overview

Widget APIs

CSS

Speialized Plugin APIs

Tracking

Chat

Callback

Adapter

Generic Plugin API

Messages

Parameters

ServiceClient

Widget UI

REST APIs

Humany widgets communicate with the backend service through a REST API. This section is directed at developers who aim at integrating with this API without using our widget APIs.

Read more and implementation details

Matching API

Search for answers and retrieve content from the knowledge base.

Read more

Notices API

List notices, news and alerts.

Read more

Contact API

List and navigate to contact methods and post form data.

Read more

Conversation API

This API is subject to change and supported.

Knowledge Base API

This API is subject to change and supported.

Webhook

Pass information posted to the Web Service contact method to an external web hook and display the response to the user in the web widget.

Read more

SEO

Read more

About

Technical documentation on humany API, widgets and integration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published