In Flashduty On-call
- In the Flashduty console, go to Integration Center → Change Events
- Select Apollo and enter an integration name
- To assign changes to specific channels, add rules under the integration’s Routes that match labels such as
app_id,environment, ornamespace - Click Save and copy the generated Push URL
Configure Apollo
Apollo supports the config release webhook since version 1.8.0. The settings live in theApolloPortalDB.ServerConfig table. You can also edit them on the Apollo Portal page Administrator Tools → System Parameters; a change takes effect in about a minute.
1
Choose the environments to push
Add or edit the setting Use the environment names shown in your Portal. For example, the environment of the quick-start (all-in-one) image is
webhook.supported.envs. The value is the list of environments that send the webhook, separated by commas:LOCAL.2
Set the push URL
Add or edit the setting Paste the Push URL exactly as Flashduty shows it. The integration key is in the path, not in an
config.release.webhook.service.url and set it to the Flashduty Push URL:?integration_key= query parameter, because Apollo appends ?env=<environment> to the configured URL. If the URL already had a query string, the integration key would be corrupted and the request would fail authentication.Flashduty reads the environment from the env parameter, so do not add query parameters to the URL yourself.3
Verify
Apollo has no test delivery: publish a config in any environment that has the webhook enabled, and the change appears in the Flashduty change list.
How changes are merged
One change is one Apollo release operation.- Two releases of the same namespace are two changes, and so are a release and a later rollback; a rollback is not merged into the original release record
- Releases in different environments are never merged
Status mapping
Theoperation Apollo sends decides the kind of change; the status is Done, except for abandoned releases (see the note below the table):
When
isReleaseAbandoned in the payload is true (the release the delivery describes has been abandoned), the change status is Canceled.
Any operation value other than the four above returns InvalidParameter and creates no change.
Change content
The title verbs are fixed Chinese words (发布 release, 回滚到 roll back to, 灰度发布 gray release, 全量发布 full release); filter on the
operation label rather than on the title.
Use labels for routing and for filtering the change list:
FAQ
Why can't I see the config values?
Why can't I see the config values?
The Apollo payload carries the full configuration after the release, which can include passwords and tokens. Flashduty does not parse it, so a change contains no config key or value. To see what changed, open the release history in the Apollo Portal.
Does changing gray release rules create a change?
Does changing gray release rules create a change?
No. Apollo sends the webhook only when a normal release, rollback, gray release, or full release completes. Changing the gray rules does not send one.
Does Apollo retry a failed delivery?
Does Apollo retry a failed delivery?
No. Apollo sends each release to each URL once and only logs an error in the Portal log when it fails. A lost delivery means the release does not appear in Flashduty.
The delivery returns an InvalidParameter error?
The delivery returns an InvalidParameter error?
env is missing: the request has noenvparameter. Check that the value ofconfig.release.webhook.service.urlis the Push URL Flashduty shows, with no query parameters added- Other
… is missing,unknown operation, orinvalid releaseTime: the payload is incomplete. Confirm it comes from the Apollo Portal release webhook and thatoperationis one of0,1,2,4
Notify webHook server failed in the Portal log for failures.