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

media

Attributes

Name	Type	Description	Readonly
id	string
category	Enum<category>	General category of what the media represents.	✔
created	OffsetDateTime		✔
deleted	boolean
favorite	boolean
label	string	Short string to describe the media. Usually set with the file name.
mime-type	string	MIME type. @see MIME types	✔
shared	Enum<shared>	How the media was shared.	✔
size	long	File size in bytes.	✔

Name	Type
creator	users

Name	Type	Description
preview	string	Link to a preview image of the file
source	string	Link to the source image of the file
upload	string	Link to file upload endpoint