When it fires
After the example flag is flipped off and the write succeeds, from the dashboard toggle (SetEnvironmentExample).
The write is idempotent: flipping a toggle that is already off changes nothing and emits no event.
The public URL starts answering 404 immediately, with the same body a link that never existed would return. Successful responses are cached for up to 60 seconds, so an already-fetched document can survive that long in an intermediary.
Payload
ts
{
type: 'environment.example_disabled',
data: {
environment: {
id: string
name: string
slug: string
projectId: string
exampleEnabled: false
updatedAt: string // ISO timestamp
}
}
}Example
json
{
"type": "environment.example_disabled",
"data": {
"environment": {
"id": "0192a1b2-c3d4-7000-8000-000000000020",
"name": "production",
"slug": "production",
"projectId": "0192a1b2-c3d4-7000-8000-000000000010",
"exampleEnabled": false,
"updatedAt": "2026-05-31T12:00:00.000Z"
}
}
}Making a product private also retracts every example link inside it, but that happens in the resolver rather than as a flag write, so it does not emit this event. The links stop resolving all the same.