Skip to content

Commit

Permalink
Merge branch 'master' into issue-3821
Browse files Browse the repository at this point in the history
  • Loading branch information
JaredTan95 authored Jul 28, 2021
2 parents d4064b6 + 8ccbbe4 commit 9bd17d2
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Apollo 1.9.0
* [fix the issue that release messages might be missed in certain scenarios](https://github.com/ctripcorp/apollo/pull/3819)
* [use official docker images for manual kubernetes deployment](https://github.com/ctripcorp/apollo/pull/3840)
* [fix size of create project button](https://github.com/ctripcorp/apollo/pull/3849)
* [translation of "portal-how-to-enable-webhook-notification.md"](https://github.com/ctripcorp/apollo/pull/3847)
* [feature: add history detail for not key-value type of namespace](https://github.com/ctripcorp/apollo/pull/3856)
* [fix show-text-modal number display](https://github.com/ctripcorp/apollo/pull/3851)

Expand Down
60 changes: 59 additions & 1 deletion docs/en/development/portal-how-to-enable-webhook-notification.md
Original file line number Diff line number Diff line change
@@ -1 +1,59 @@
TODO
Starting with version 1.8.0, Apollo has added webhook support, which will be triggered to send you a message when your configuration is released.

## How to enable webhook

> The configuration items are stored in the table named ApolloPortalDB.ServerConfig. You may also config them in `Admin Tools - System Configuration` page. The configuration changes will take effect within one minute.
1. webhook.supported.envs

The environment lists to enable webhook support. Multiple environments should be separated by commas, e.g.,

```
DEV, FAT, UAT, PRO
```

2. config.release.webhook.service.url

Config the url that receives HTTP post request sent by webhook for notifying. Multiple urls should be separated by commas, e.g.,

```
http://www.xxx.com/webhook1,http://www.xxx.com/webhook2
```

## How to use

1. URL parameters

parameter name | parameter annotation
--- | ---
env | env of the configuration to be released

2. Request body sample

```json
{
"appId": "", // appId
"clusterName": "", // cluster
"namespaceName": "", // namespace
"operator": "", // modifier
"releaseId": 2, // release id
"releaseTitle": "", // release title
"releaseComment": "", // release Comment
"releaseTime": "", // release time eg:2020-01-01T00:00:00.000+0800
"configuration": [ { // all configurations to be released; also applys to gray release
"firstEntity": "", // key of configuration
"secondEntity": "" // value of configuration
} ],
"isReleaseAbandoned": false,
"previousReleaseId": 1, // releaseId of latest formal release
"operation": // 0-normal release 1-rollabck 2-gray release 4-full release
"operationContext": { // property setting for operation
"isEmergencyPublish": true/false, // emergercy release or not
"rules": [ { // rules for gray release
"clientAppId": "", // appId
"clientIpList": [ "10.0.0.2", "10.0.0.3" ] // IP lists
} ],
"branchReleaseKeys": [ "", "" ] // key of Gray Release
}
}
```

0 comments on commit 9bd17d2

Please sign in to comment.