Join us from October 8-10 in New York City to learn the latest tips, trends, and news about GraphQL federation and API platform engineering.Join us for GraphQL Summit 2024 in NYC
Start for Free

Schema change notifications

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

Configure to notify your team whenever your graph's registered schema changes. You can receive notifications via Slack, custom webhook, or both.

Schema notification Slack message.



If you want to receive notifications via both Slack and webhook, repeat these setup steps for both.

  1. Go to your graph's Settings page in GraphOS Studio.
  2. Open the Reporting tab.
  3. Click Add notification in the upper right.
  4. Select Schema Change and click Next.
  5. In the dropdown, select which graph variant you want to receive notifications for.
  6. Select either an existing notification channel or select which type of new channel you want to configure. Click Next.
  7. If you're configuring a new channel, complete the steps in the next section.

Configure a new channel


To set up Slack notifications, you must:

  1. Create an incoming webhook in Slack.
  2. Provide that webhook's URL to .

1. Create an incoming Slack hook

To create an incoming Slack hook:

  1. From the Incoming Hooks page of the Slack App Directory, sign in and click Add to Slack.
  2. Select the Slack channel that should receive notifications. Then, click Add Incoming WebHooks integration.
  3. Copy the Webhook URL to use in the next step. It should have a format like

You can repeat this process to create webhook URLs for different Slack channels.

2. Provide the Slack hook to Studio

  1. In GraphOS Studio, specify a name for this notification channel in the Channel Name .

    • This name must be unique among your 's notification channels.
    • This name doesn't have to match the name of the Slack channel, but it's recommended for simplicity.
  2. In the Slack Webhook URL field, paste the webhook URL you obtained in Create an incoming Slack hook.

  3. Click Next.

  4. After you finish setup, check that your Slack channel gets a confirmation from Studio.

To configure multiple Slack channels, repeat this process. Use a different webhook URL for each channel.


Sending notifications via webhook is only available with a GraphOS Enterprise plan.

Custom webhooks require you to set up an HTTPS endpoint accessible via the public internet. GraphOS sends webhook notifications to this endpoint as POST requests. Notification details are provided as JSON in the request body, as described in the next section.

  1. Specify a name for this notification channel in the Channel Name field. This name must be unique among all your graph's notification channels, including Slack channels.
  2. In the Webhook URL input, provide the URL of your HTTP(S) endpoint.
  3. Click Next and complete any remaining steps in the dialog.

Webhook format

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:

interface Change {
description: string;
interface ResponseShape {
eventID: string;
changes: Change[];
schemaURL: string;
schemaURLExpiresAt: string;
graphID: string;
variantID: string;
timestamp: string;

Field descriptions


The schema change event; currently, always SCHEMA_PUBLISH


A unique event ID


The set of schema changes that occurred


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.


An ISO 8601 Date string indicating when the schemaURL expires


A unique graph ID


An unique ID in the format, for example, graphID@variantName


An ISO 8601 Date string indicating when the event occurred

Daily reports
Performance alerts
Rate articleRateEdit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy