This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

General best practices for handling downtime

When your integration uses Toast API servers, use the following recommended best practices to handle a downtime window:

  • Programmatically evaluate the health of a Toast API in your error handling code. A high volume of 5XX errors within a short window of time often means that there is a temporary issue in one or more of the Toast APIs.

    For more information about Toast API error codes, see HTTP status codes.

  • If you receive a 5XX error when you use a Toast API, reduce your polling frequency at an exponential rate. See this information about exponential backoff processes.

  • If your integration retrieves information such as orders or time entries based on their last modification timestamp, use the timestamp of your last successful poll attempt when you evaluate how to backfill any missed data.

    The instant of the last successful data retrieval should be the start timestamp of your next attempt to retrieve data.

  • If your integration relies on real-time data from the Toast platform, be sure you cache all necessary data so that your integration remains reliable even during an unexpected downtime.