About the documentation

Serviceware Messaging provides a public HTTP API following the JSON:API specification.

The API resources use some standard formats for some of its attributes. You can find an overview of these in the Standards page.

JSON:API allows us to define custom error codes for specific failures. Serviceware Messaging specific errors are listed in the list of error codes.

Note: For general information on the module Serviceware Messaging, please read the user documentation.

Important resources

Due to Serviceware Messaging being a messaging service, there are some core resources:

  • users - a Serviceware Messaging user

  • rooms - contains many events and is usually used to allow users to communicate with each other

  • events - represent things that happen in Serviceware Messaging. For example a text message or some updates like a user changing its name

You can find additional resources in the resource list in the navigation.