May 27, 2021

Introducing Build Checks and Webhooks In Apollo Studio

Caydie Tran

Caydie Tran

Federation Support in Apollo Studio Just Got a Whole Lot Better

Preventing breaking changes when working on a shared data graph is critical. Last year, we launched schema checks in Apollo Studio to help you collaborate on your graph with confidence. Checks validate your schema changes against historical operations to ensure your changes will not break your clients. However, for federated graphs, in addition to checking that your operations won’t break, we also need to check to see whether the supergraph schema is successfully built, meaning that it successfully composed the supergraph schema from the underlying subgraph schemas. Before today, our platform did build checks but didn’t expose the results in Studio, which required going into the CLI to see why a supergraph build failed.

Here at Apollo, we understand how important it is to have visibility of your federated graph’s composition, and we’re delighted to announce build checks and webhooks to help you better understand the impact of schema changes, update your data graph faster, and allow more teams to contribute to the graph safely. 🎉

Build checks for federated graphs

With the addition of build checks, you will now have better visibility into why a build failed for your subgraph’s schema changes. With this release comes a few additions and improvements:

  • Better visibility: If the build fails, the build page will display all errors that occurred when trying to compose your changes. You’ll also be able to download or copy the subgraph schema and the resulting supergraph schema when available. Use the downloaded schema for codegen, linting, or mocking!
  • Better UX: The recent checks page now introduces filters. Use these filters to quickly find checks based on the check status, author, subgraph, or branch, helping you find what you’re looking for and surface root cause faster.
GraphQL build errors example
Example of failed build check
GraphQL successful build
Example of a successful build check
Apollo Studio GraphQL subgraph filter
New filtering capability with checks

Build Webhooks

We’ve also made it possible to configure build webhooks for your graph so that you can be notified when a new schema is built and ready to ship to your running gateway. You can also use this to alert on broken builds so that you can more quickly resolve errors when they happen.

Apollo Studio GraphQL build webhooks notifications
Set up a webhook to get notified when supergraph schema is built

Webhooks are part of the Studio Enterprise plan. Please reach out to us if you are interested in this feature.

Get started

Want to try out the new check experience today? See the docs to learn more and see how to try it out!

Written by

Caydie Tran

Caydie Tran

Read more by Caydie Tran