构建状态通知
在 GraphOS 尝试构建新的超级图模式时接收 webhook 警报
此功能仅在 GraphOS 专用或企业计划中可用。
要比较不同计划的 GraphOS 功能支持情况，请参阅 定价页面.
此功能处于 预览
配置GraphOS发送通知到webhook，每当GraphOS试图构建新的supergraph雪仁时。通知指示构建是否成功。成功的构建通知包括指向新supergraph雪仁的临时URL。
设置
- 访问你在 GraphOS Studio.
- 打开报告标签页。
- 在右上角点击添加通知。
- 选择构建状态并点击 下一步.
- 在下拉菜单中，选择你想要接收通知的图变种。
- 选择现有的通知渠道，或选择你想要配置的新渠道类型。点击下一步。
- 如果你正在配置新的渠道，请参阅下一段的步骤。
配置webhook
自定义webhook需要你设置一个可通过公共互联网访问的HTTPS端点。GraphOS将webhook通知作为POST请求发送到该端点。通知详情已在下一节中描述。
- 在 渠道名称字段中为这个通知渠道指定一个名称。此名称必须在你所有图的通知渠道中独一无二，包括Slack渠道。
- 在Webhook URL输入中提供你HTTP(S)端点的URL。
- 点击下一步并完成对话框中的任何剩余步骤。
Webhook格式
自定义webhook通知详情以JSON对象的形式提供在请求体中。
JSON对象符合ResponseShape接口的结构：
interface BuildError {message: string;locations: ReadonlyArray<Location>;}interface Location {line: number;column: number;}interface ResponseShape {eventType: 'BUILD_PUBLISH_EVENT';eventID: string;supergraphSchemaURL: string | undefined;buildSucceeded: boolean;buildErrors: BuildError[] | undefined;graphID: string;variantID: string;timestamp: string;}
字段描述
| 字段 | 描述 |
|---|---|
| 构建状态事件名; 当前始终 |
| 唯一事件ID |
| 如果构建成功，一个短暂的（24小时）URL，使您能够获取 supergraph方案而无需验证（例如使用API密钥）。 如果构建失败，此字段不存在。 |
| 构建是否成功 |
| 如果构建失败，將會有一個描述在构建過程中發生的錯誤的 如果构建成功，這個字段就不會存在。 |
| 一個獨一的圖 longo ID |
| 在圖 Nuggets 格式中的一個獨一 |
| 表示事件發生時間的ISO 8601日期字串 |