Checks

The Vercel Checks API let you create tests and assertions that run after each deployment has been built. They are powered by Integrations, which allow you to connect any third-party service of your choice with Vercel.

Endpoints

Status and conclusion

Once the Checks API start implementing on your deployment, its status is set to running. Updating the Check with a conclusion will automatically set the Check status to completed. This results in a successful deployment.

However, your deployment will fail if the conclusion updates to one of the following values:

Output

Vercel's Checks API is capable of generating rich output results that can store arbitrary data, Web Vitals and a Virtual Experience Score through the output property.

To include Web Vitals and a Virtual Experience Score, the following can be passed to output under a metrics field:

Retrieve a list of all checks

get /v1/deployments/{deploymentId}/checks

List all of the checks created for a deployment.

Creates a new Check

post /v1/deployments/{deploymentId}/checks

Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

Get a single check

get /v1/deployments/{deploymentId}/checks/{checkId}

Return a detailed response for a single check.

Update a check

patch /v1/deployments/{deploymentId}/checks/{checkId}

Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.