Build status notifications

Receive webhook alerts whenever GraphOS attempts to build a new supergraph schema

This feature is only available with a GraphOS Dedicated or Enterprise plan.
To compare GraphOS feature support across all plan types, see the

pricing page

This feature is in

preview

. Your questions and feedback are highly valued—don't hesitate to get in touch with your Apollo contact or on the official

Apollo GraphQL Discord

You can

configure GraphOS

to notify your team via webhook whenever GraphOS attempts to build a new supergraph schema for your

federated graph

. The notification indicates whether the build 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 GraphOS 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:

1
interface BuildError {
2
  message: string;
3
  locations: ReadonlyArray<Location>;
4
}
5

6
interface Location {
7
  line: number;
8
  column: number;
9
}
10

11
interface ResponseShape {
12
  eventType: 'BUILD_PUBLISH_EVENT';
13
  eventID: string;
14
  supergraphSchemaURL: string | undefined; // See description below
15
  buildSucceeded: boolean;
16
  buildErrors: BuildError[] | undefined; // See description below
17
  graphID: string;
18
  variantID: string; // See description below
19
  timestamp: string; // ISO 8601 Date string
20
}

If the build succeeds, the value of supergraphSchemaURL is a short-lived (24-hour) URL that enables you to fetch the supergraph schema without authenticating (such as with an API key). Otherwise, this field is not present.
If the build fails, buildErrors is an array of BuildError objects that describe the errors that occurred during the build. Otherwise, this field is not present.
The value of variantID is in the format graphID@variantName (for example, mygraph@staging). This format is known as a
graph ref
.

Performance alerts