Dev guideAPI Reference
Dev guideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Agent notifications

Optimizely Agent provides an endpoint that sends notifications to subscribers using Server-Sent Events. This is Agent's equivalent of Notification Listeners found in the Optimizely Feature Experimentation SDKs.

For details on the notification types, what causes them to be triggered, and the data they provide, see Set up notification listener documentation for the Go SDK.


By default, the notifications endpoint is disabled. To enable it, update theconfig.yaml file:

# config.yaml
    enableNotifications: true

Or, enable it by setting an environment variable:

# set an env. variable


Send a GET request to /v1/notifications/event-stream to subscribe:

curl -N -H "Accept:text/event-stream" -H "X-Optimizely-Sdk-Key:<YOUR SDK KEY>"\

This connection will remain open, and any notifications triggered by other requests received by Agent are pushed as events to this stream. Try sending requests to /v1/activate or /v1/track to see notifications being triggered.


To subscribe only to a particular category of notifications, add a filter query parameter. For example, to subscribe only to Decision notifications:

# filter on decision notifications
curl -N -H "Accept:text/event-stream" -H "X-Optimizely-Sdk-Key:<YOUR SDK KEY>"\

When the Agent is operating in High Availability (HA) mode, you need to enable notification synchronization to get notifications from the nodes in an HA setup. A PubSub system (Redis) is now used to ensure consistent retrieval of notification events across all nodes in an HA setup.

Here is an example of how you can enable the notification synchronization with Redis:

## synchronization should be enabled when features for multiple nodes like notification streaming are deployed
            host: "localhost:6379"
            password: ""
            database: 0
    ## if notification synchronization is enabled, then the active notification event-stream API
    ## will get the notifications from available replicas
        enable: true
        default: "redis"


For a runnable Python example, see examples/ in GitHub.