模式建议通知

配置GraphOS以向 webhook 发送通知，每次创建或修改架构提案或其状态更改时。这些 webhook 有助于自动化工作流程。例如，当提案的状态更改为批准时，您的组织可能希望在代码库中打开草稿拉取请求。

设置

1. 转到您的graph's设置页面，页面位于GraphOS Studio.

2. 打开报告选项卡。

3. 在右上角点击添加通知。

4. 选择架构提案并点击下一步。

5. 选择您想要接收通知的架构提案事件：

   • 提案创建
   • 提案修订
   • 提案状态更改

6. 选择现有的 webhook 通知通道或创建一个新通道。如果创建新的通道，请根据下一节描述配置 webhook。

配置 webhook

自定义 webhook 需要在公共互联网上可访问的 HTTPS 端点设置。 GraphOS会将 webhook 通知发送到此端点作为POST请求。通知详情作为下一节所述的 JSON 提供在请求体中。

1. 在通道名称字段中，为本通知通道指定一个名称。此名称必须在全graph's 通知通道（包括 Slack 通道）中唯一。

2. 在Webhook URL输入框中，提供您的 HTTP(S) 端点 URL。

3. 可选地，输入一个密钥令牌。

   如果您输入了一个令牌，则每个通知HTTP请求都包含一个x-apollo-signature标题头部，其值是一个使用该令牌、请求数据作为消息和SHA256散列函数生成的哈希消息认证码（HMAC）。该x-apollo-signature标题头部的格式为sha256=<hmac-value>。

   查看示例

   给定以下输入

   密令（密钥）:your_secret_token

   请求正文（消息）:

   JSON

   1
   {
   2
     "eventType": "APOLLO_PROPOSAL_STATUS_CHANGE",
   3
     "eventId": "00000000-0000-0000-0000-00000000",
   4
     "graphId": "graphId",
   5
     "variantId": "p-1",
   6
     "proposalId": "00000000-0000-0000-0000-00000000",
   7
     "change": {
   8
       "status": "OPEN",
   9
       "previousStatus": "DRAFT"
   10
     },
   11
     "timestamp": "1970-01-01T00:00:00+0000"
   12
   }

   复制

   散列函数: SHA256

   该x-apollo-header的值将是sha256=0400670a3ea155eb9f602a60e7897e72515e1a4b04fe06a786e631cc32a1307e。

   参考此Okta指南以了解更多关于实施的情况以及查看其他资源。

4. 单击下一步并完成对话框中剩余的步骤。

Webhook格式

自定义Webhook通知细节以JSON对象形式在请求体中提供。为了避免包含敏感信息，有效载荷包含ID，例如提案ID和修订ID，而不是包含提案或修订详细信息的对象。您可以使用平台API使用Webhook负载中的ID获取完整对象。

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

1
enum ProposalStatus {
2
  OPEN
3
  DRAFT
4
  IMPLEMENTED
5
  APPROVED
6
}
7

8
interface ResponseShape {
9
  "eventType": string;
10
  "eventID": string;
11
  "graphID": string;
12
  "variantID": string;
13
  "proposalID": string;
14
  "change": {
15
    "status": ProposalStatus | undefined
16
    "previousStatus": ProposalStatus | undefined
17
    "revisionId": string | undefined
18
  },
19
  "timestamp": string;
20
}

字段描述