When it fires
After the example flag is flipped on and the write succeeds, from the dashboard toggle (SetEnvironmentExample).
One condition has to hold first, so this event never fires without it:
- The environment's product is not private.
Unlike environment.exposed, this event does not require Virtual Envs to be enabled on the workspace. The two features are independent.
The write is idempotent: flipping a toggle that is already on changes nothing and emits no event.
Payload
{
type: 'environment.example_enabled',
data: {
environment: {
id: string
name: string
slug: string
projectId: string
exampleEnabled: true
updatedAt: string // ISO timestamp
}
}
}Example
{
"type": "environment.example_enabled",
"data": {
"environment": {
"id": "0192a1b2-c3d4-7000-8000-000000000020",
"name": "production",
"slug": "production",
"projectId": "0192a1b2-c3d4-7000-8000-000000000010",
"exampleEnabled": true,
"updatedAt": "2026-05-31T12:00:00.000Z"
}
}
}This is a much quieter event than environment.exposed. The example feed serves no values and no ciphertext, only the variable names and their metadata. What it does publish is a complete inventory of your key names, which is worth knowing about even though nothing decryptable left the perimeter.