Notifications

Notifications are used to provide provide the Signagelive UI with information about the state of the client.

Request

Verb URI Description
POST {api_version}/client/notifications/ Posts a notification that the client has performed an action.
Headers:
Header Description
X-SIGNAGELIVE-APP-ID Application IDs will be issued by Signagelive and are unique to the client application when a new client application is added to Signagelive.
X-SIGNAGELIVE-APP-KEY Application Keys are managed via the developer portal and are used to authenticate the application with the API.
X-SIGNAGELIVE-AUTH-TOKEN The authentication token returned by the authentication method.

Body:

Field definitions:
Name Description Required
type The action performed by the client. See below for details. Yes
object_id The ID of the object that the notification relates to (if applicable) No – see below
data Custom information regarding the event being sent. This can be a simple text message or a json string. No

Notification Types:

Type Description Notes
SystemStart A notification that the client has initialized – this should be called after a bootup of the device or software is started. object_id not required
HealthCheck A notification that the client is up and running at that all systems are operational.

This should be called regularly at the interval defined in the configuration response connectivity object, health_check_interval property.

object_id not required
DownloadStart A notification that the player has begun to download a layout, playlist, media asset or other object. object_id required
DownloadComplete A notification that the player has completed the download of a layout, playlist, media asset or other object. object_id required
DownloadFail A notification that a download has failed. object_id required
DeleteMediaFile A notification that the client has deleted a file from the local system object_id required
FirmwareUpdateComplete A notification that a firmware update has been applied successfully. object_id not required
FirmwareUpdateFailed A notification that a firmware update has failed. object_id not required
ContentDownloadComplete A notification that all content has been downloaded successfully. Using this instead of the using DownloadComplete event on individual items means that download progress cannot be viewed from Signagelive. object_id not required

Please note that PlayStart, PlayComplete and PlayFail will not be available in the the initial release of the API.

Normal response code: 204

Alternative reponse code: 403 – This response will be sent when the player has not yet been activated with a Signagelive licence. The request should not be re-sent.