Schema change notifications

Receive alerts whenever changes are made to your graph's schema

You can

to notify your team whenever any changes (additions, deprecations, removals, etc.) are made to your graph's registered schema:

You can configure separate change notifications for each

variant

of your graph.

Setup

See

Setting up GraphOS Notifications

Webhook format

If you receive schema change notifications via a

custom webhook

, notification details are provided as a JSON object in the request body.

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

1
interface Change {
2
  description: string;
3
}
4

5
interface ResponseShape {
6
  eventType: "SCHEMA_PUBLISH"; // Currently, only SCHEMA_PUBLISH webhooks are supported
7
  eventID: string;
8
  changes: Change[]; // Set of schema changes that occurred
9
  schemaURL: string; // See description below
10
  schemaURLExpiresAt: string; // ISO 8601 Date string
11
  graphID: string;
12
  variantID: string; // See description below
13
  timestamp: string; // ISO 8601 Date string
14
}

The value of schemaURL is a short-lived (24-hour) URL that enables you to fetch the published schema without authenticating (such as with an API key). The URL expires at the time indicated by schemaURLExpiresAt.
The value of variantID is in the format graphID@variantName (for example, mygraph@staging).

Daily reports

Performance alerts