/
Launch Apollo Studio

Build status notifications (preview)


Build status notifications require an Enterprise plan. They are currently in preview.

You can configure Apollo Studio to notify your team via webhook whenever Apollo attempts to compose a new supergraph schema for your federated graph. The notification indicates whether composition succeeded and provides a temporary URL to the new supergraph schema if so.

You can configure separate change notifications for each variant of your graph.

Setup

See Setting up Studio Notifications.

Webhook format

Build status notifications are sent exclusively as webhooks. Details are provided as a JSON object in the request body.

The JSON object conforms to the structure of the ResponseShape interface:

interface BuildError {
  message: string;
  locations: ReadonlyArray<Location>;
}

interface Location {
  line: number;
  column: number;
}

interface ResponseShape {
  eventType: 'BUILD_STATUS_UPDATE';
  eventID: string;
  supergraphSchemaURL: string | undefined; // See description below
  buildErrors: BuildError[] | undefined; // See description below
  graphID: string;
  variantID: string; // See description below
  timestamp: string; // ISO 8601 Date string
}
  • If composition succeeds, the value of supergraphSchemaURL is a short-lived (24-hour) URL that enables you to fetch the supergraph core schema without authenticating (such as with an API key). Otherwise, this field is not present.
  • If composition fails, buildErrors is an array of BuildError objects that describe the errors that occurred during composition. Otherwise, this field is not present.
  • The value of variantID is in the format graphID@variantName (e.g., mygraph@staging). This format is known as a graph ref.
Edit on GitHub