Home ci 09. deployments: Working with Checks

09. deployments: Working with Checks

Last updated on Aug 05, 2025

Epycbyte automatically keeps an eye on various aspects of your web application using the Checks API. Learn how to use Checks in your Epycbyte workflow here.

Table of Contents

  1. Types of Flows Enabled by Checks API
  2. Checks Lifecycle
  3. Building Your Checks Integration

Types of Flows Enabled by Checks API

  • Core Checks:

    • 200 responses on specific pages or APIs.
    • Determine the deployment's health and identify issues with code, errors, or broken connections.

  • Performance:

    • Collects core web vital information for specific pages and compares it with the new deployment.
    • Helps you decide whether to build the deployment or block it for further investigation.

  • End-to-end:

    • Validates that your deployment has all required components to build successfully.
    • Identifies any broken pages, missing images, or other assets.

  • Optimization:

    • Optimizes information about the bundle size.
    • Ensures your website manages large assets like package and image sizes.

Checks Lifecycle

The diagram shows how a check works:

  1. When a deployment is created, Epycbyte triggers the deployment.created webhook. This tells integrators that checks can now be registered.
  2. An integrator uses the Checks API to create checks defined in the integration configuration.
  3. When the deployment is built, Epycbyte triggers the deployment.ready webhook. This notifies integrators to begin checks on the deployment.
  4. Epycbyte waits until all created checks receive an update.
  5. Once all checks receive a conclusion, aliases will apply, and the deployment will go live.

Building Your Checks Integration

To build your Checks integration:

  1. Provide low or no configuration solutions for developers to run checks.
  2. Include a guided onboarding process from installation to the end result.
  3. Provide relevant information about the outcome of the test on the Epycbyte dashboard.
  4. Document how to go beyond default behavior to build custom tests for advanced users.

Was this helpful?

Yes, it was! If you have more questions or need further assistance, feel free to ask below:

Send