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

users

Attributes

Name	Type	Description	Readonly	notBlank
id	string
confirmed	boolean		✔
created	OffsetDateTime		✔
display-name	string
email	string
enabled	boolean	Whether the user is still able to use the system.
external-id	string	External id	✔
family-name	string
given-name	string
language	string			✔