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

states

Represents a rooms state.

Attributes

Name	Type	Description	Deprecated
customer-receipt	events	Most recent event that has been read by the customer. Only set in valid support rooms.
events	List < events >	Represent the room's current set of state-events.
last-activity	events	Last activity event of the room.	✔
receipt	events	Most recent event that has been read by the user.
support-receipt	events	Most recent event that has been read by a support operator. Only set in valid support rooms.