About the documentation
Serviceware Messaging provides a public HTTP API following the JSON:API specification.
API
The API resources use some standard formats for some of its attributes. You can find an overview of these in the page. JSON:API allows us to define custom error codes for specific failures. specific errors are listed in the list of error codes.
Integration
Read about support integrations and webhooks.
Events
Event resources behave differently depending on their event type. The following table gives an overview of which event type implies what functionality.
Resource types
Here you find an overview of all resource types.
Types

customers

A customer is a synthetic resource, i.e. not persisted. It is identified by the roomId.

Attributes

Name	Type
id	string

Name	Type	Description
livechat	livechats
room	rooms	The SUPPORT room of `user` that is associated with `livechat`.
user	users

Name	Type	Description
export	string	Link to retrieve this customers conversation history