Skip to main content

In-App Announcements

In-app announcements enable us to inform all or selected customers about important changes and eventual incidents affecting our services. In-app announcements are primary communication channels in case of an incident.

In-app announcements are designed to be extremely reliable and independent of our other services. Even when the rest of our services are experiencing issues in-app announcements should keep the communication channel open to our customers. This makes it possible to keep all users informed directly in our application about whatever is happening so they do not have to search for details anywhere else.

Downloading Announcements​

You can download announcements directly via HTTPS in case even the Salted CX application user interface is not available. The status files are available at the following locations:

  • https://status.salted.cx/announcements.json — Global announcements that apply to all customers.
  • https://status.salted.cx/<region>/announcements.json — Region-specific announcements that apply to all accounts in the given region.
  • https://status.salted.cx/<region>/<account domain>/announcements.json — Contains announcements for a specific account.
note

We do not disclose any sensitive information in the announcements to enable these announcements to be accessible with a minimum number of services involved to maximize the service availability and reliability.

If you want to retrieve the current status of your account and you have the domain company.eu.salted.cx in Salted CX you need to download the following files:

  • https://status.salted.cx/announcements.json
  • https://status.salted.cx/eu/announcements.json
  • https://status.salted.cx/eu/company/announcements.json

Announcement Format​

Each announcement is a JSON file with an array of individual announcements. The following code snippet shows an example announcement file.

[
	{
		"message": "This is an example announcement with all supported properties",
		"details": "This explains the announcement in greater detail.",
		"link": "https://help.salted.cx",
		"color": "blue",
		"fromTime": "2024-05-31T00:00:00Z",
		"toTime": "2024-05-31T03:00:00Z",
		"dismiss": true,
		"type": "fullscreen"
	},
	{
		"message": "Only the message of the announcement is mandatory.",
	}
]

The following properties are supported:

  • message is a free text that is shown to a users
  • details (optional) is a free text with more details about the announcement
  • link (optional) to more information outside of the application
  • color (optional, default blue) of the announcement in the user interface, possible values red, yellow, green, blue and grey
  • fromTime (optional) is time from which the announcement is shown fromTime
  • toTime (optional) is time until when the announcement is shown toTime
  • dismiss (optional, default true) tells whether the announcement can be dismissed by users, possible values are true and false
  • type (optional, default notification) tells how the announcement is visualized, possible values are notification (shows as a notification bar in the application) and fullscreen (overlay over the entire application)