模式变更通知

配置GraphOS 用于在您的图注册的架构发生更改时通知您的团队。您可以通过Slack、自定义webhook或两者都使用来接收通知。

设置

1. 请前往您的图的 设置 页面 在GraphOS Studio中.
2. 打开 报告 选项卡。
3. 在右上角点击 添加通知。
4. 选择 架构更改 并点击 下一步.
5. 在下拉菜单中选择您想要接收通知的图变体。
6. 选择现有的通知渠道或选择您想要配置的新渠道类型。点击 下一步。
7. 如果您正在配置新渠道，请完成下一节的步骤。

配置新渠道

Slack

要设置Slack通知，您必须

1. 在Slack中创建一个传入webhook。
2. 提供该webhook的URL到 GraphOS Studio.

1. 创建传入的Slack钩子

要创建传入的Slack钩子

1. 从 传入钩子 页面，登录并点击 添加到Slack.
2. 选择应接收通知的Slack频道。然后，点击 添加传入WebHooks集成.
3. 复制用于下一步骤的 Webhook URL。它应该是类似 https://hooks.slack.com/services/... 的格式。

您可以使用此过程创建不同Slack频道的webhook URL。

2. 向Studio提供Slack钩子

1. 在 GraphOS Studio 中，在 频道名称 字段 中指定此通知渠道的名称。

   • 此名称必须在您的 图's 通知渠道中是唯一的。
   • 此名称不必与Slack频道的名称匹配，但建议为了简单起见这样做。

2. 在 Slack Webhook URL 字段 中，粘贴您在 创建传入的Slack钩子 中获得的webhook URL。

3. 点击 下一步.

4. 设置完成后，请检查您的Slack频道是否收到来自Studio的确认。

要配置多个Slack频道，请重复此过程。每个频道使用不同的webhook URL。

Webhook

自定义webhook需要您设置一个可通过互联网访问的HTTPS端点。GraphOS会将webhook通知作为POST请求发送到该端点。通知详情以JSON格式在请求体中提供，具体内容请参阅下一节。

1. 在 通道名称字段中为此通知通道指定一个名称。
2. 在Webhook URL输入中，提供您的HTTP(S)端点URL。
3. 点击下一步并完成对话框中的其他步骤。

Webhook格式

自定义webhook通知详情以JSON对象的形式在请求体中提供。

该JSON对象符合ResponseShape接口的结构：

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

5
interface ResponseShape {
6
  eventType: 'SCHEMA_PUBLISH'
7
  eventID: string;
8
  changes: Change[];
9
  schemaURL: string;
10
  schemaURLExpiresAt: string;
11
  graphID: string;
12
  variantID: string;
13
  timestamp: string;
14
}

字段描述