For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Copy to LLM Github Go to App

Documentation Integrations Building Self-Improving Agents Self-hosting Opik SDK & API reference

Documentation Integrations Building Self-Improving Agents Self-hosting Opik SDK & API reference

- Overview
Python SDK
Typescript SDK
Rest API
- Overview
- - GETFind alerts
    POSTCreate alert
    POSTDelete alert batch
    GETGet Alert by id
    PUTUpdate alert
    GETGet webhook payload examples
    POSTTest alert webhook

Copy to LLM Github Go to App

Rest API API Reference Alerts

Get webhook payload examples

GET

/v1/private/alerts/webhooks/examples

GET

/api/v1/private/alerts/webhooks/examples

$ curl http://localhost:5173/api/v1/private/alerts/webhooks/examples

200Retrieved

1 {
2   "response_examples": {}
3 }

Get webhook payload examples for all alert event types, optionally filtered by alert type

Was this page helpful?

Test alert webhook

Query parameters

alert_typeenumOptional

Allowed values:

Response

Webhook examples

response_examplesmap from strings to objects