environment.* events
The lifecycle and the state of a project's environments: creation, edits, deletion, change freezes and the health the checks find.
The lifecycle and the state of a project's environments: creation, edits, deletion, change freezes and the health the checks find. An environment is one place the project's software runs, so a deployment pipeline, a status page or a chat alert subscribes here to learn where it may deploy and what is up.
Every event in the family is scoped to the project, so project_id in the envelope is always set and an endpoint confined to one project receives only that project's events. The payloads are thin on purpose: the ids, the name and what the transition itself carries, never a snapshot of the environment and never a secret. Read the environments endpoint for the record.
Background
Required ability
Tokens subscribing to environment.* events need environment:view at mint time.
Events
environment.createdAn environment is added.environment.updatedAn environment's fields change.environment.deletedAn environment is deleted.environment.frozenA change freeze starts.environment.unfrozenA change freeze is lifted before it ends.environment.health_changedA check finds the environment in a different health than before.How is this guide?
Last updated on