Home
Resource types
Here you find an overview of all resource types.
rooms

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

rooms

Attributes

Name	Type	Description	Readonly
id	string
closed	OffsetDateTime	Close time. Is null if the room is open otherwise timestamp when is was closed.	✔
created	OffsetDateTime	Creation time.	✔
joinable	boolean	Defines whether the user is allowed to join the room or not. Based on the list of existing members.	✔
name	string
type	Enum<room-type>

Relationships

Name	Type	Description
creator	users	User who created the room.
events	List < events >	Events in the room.
livechat	livechats
members	List < users >	Collection of members.
parent	rooms	Parent of the room. Can be null.
state	states	State of the room.
tags	List < Tag >	Collection of tags.

Links

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