Skip to main content

Experiment Update Webhook

Webhooks let your integrations take action in response to events that occur in Eppo. The Experiment Update Webhook is a good solution when a custom application needs to display or take action on the most up to date state of an experiment.

Webhook Events​

The webhook sends four types of experiment update events. If you only want to take action based on certain types of events, you can filter to just the events you are interested in subscribing to based on their event type in the request body.

EventTriggersRequest body
experiment.metric.updated
  • When metric is added / removed
  • When metric collection is added / removed
    		• {
    "event": "experiment.metric.updated",
    "data": {"experiment_id": <experiment_id>,"experiment_key": "<experiment_key>"},
    "signature": "<signature>"
    }
    experiment.configuration.updated
  • When user edit any configuration
    		• {
    "event": "experiment.configuration.updated",
    "data": {"experiment_id": <experiment_id>,"experiment_key": "<experiment_key>"},
    "signature": "<signature>"
    }
    experiment.status.updated
  • When experiment's status changes
    		• {
    "event": "experiment.status.updated",
    "data": {"experiment_id": <experiment_id>,"experiment_key": "<experiment_key>"},
    "signature": "<signature>"
    }
    experiment.calculated_metrics.updated
  • When data pipeline run irrespective of success or failure and mode of trigger manual or scheduled
    		• {
    "event": "experiment.calculated_metrics.updated",
    "data": {
    "experiment_id": <experiment_id>,
    "experiment_key": "<experiment_key>",
    "meta_data": {
    "status": "<success | failure>",
    "is_manual_refresh": <boolean>,
    "is_data_updated": <boolean>,
    "time_taken_seconds": <number>,
    "is_traffic_imbalance": <boolean>,
    "assignments_scan_start_date": <date>,
    "assignments_scan_start_date": <date>
    }
    },
    "signature": "<signature>"
    }

    Configuring the webhook​

    To use the webhook, you first need to setup a URL on your side to receive the webhook payload. Once that is done, contact Eppo support to set and enable the webhook.