A request is made, when any user who has activated your app, views your app page or clicks the Status & troubleshooting tab in the App Directory.

POST https://yourapp.com/status

Upsales sends a POST request with a JSON body. The body has the same properties as every other request to your app, see Request body. Your app endpoint must use HTTPS.

Use this endpoint if your app has ongoing issues, the app configuration is not working or just that everything is fine and up and running.

Status code

Respond with the status code that best corresponds to your apps' status at the moment.

200
We'll show your app as up and running to the user. Other 2xx codes don't report a status.

404
We'll show the user your app has yet to implement a status report.

3xx, 4xx and 5xx (except 404)
We'll show the user your app has ongoing issues. Use the message property in the body of the response to explain why.

Not responding
If your app is not responding at all, or doesn't respond within 30 seconds. We'll show your app as down at the moment.

Response body

No matter if you're responding with a successful status code or not, we'll show anything in the message property of your response to the user.

{
  "message": "Your configuration is not working."
}

Pro tips when responding

• Use markdown to format your response message. HTML is stripped down to basic formatting tags, so write links as markdown links.
• Check the config you'll receive in the body to validate if there's any problem with the users configuration.
• Use the message property for some common troubleshooting advice, even if your app is running fine in general.