Update alert | Opik Documentation

PUT/v1/private/alerts/{id}Update alert

Update alert

Parameters

idstring · uuidpathrequired

Request body

application/json

objectAlert_Write

alert_typestring

one of "general", "slack", "pagerduty"

enabledboolean

idstring · uuid

metadataobject

namestring

maxLength 255 · minLength 0

project_idstring · uuid

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a 'scope:project' trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

triggersarray of object

Show child attributes

Show array items

event_typestringrequired

one of "trace:errors", "trace:feedback_score", "trace_thread:feedback_score", "prompt:created", "prompt:committed", "trace:guardrails_triggered", "prompt:deleted", "experiment:finished", "trace:cost", "trace:latency"

idstring · uuid

trigger_configsarray of object

Show child attributes

Show array items

config_valueobject

group_indexinteger · int32

Groups configs within a trigger: same group_index means AND between configs, different group_index means OR between groups. Null means a legacy/singleton group of one config. Always null for scope:project configs.

idstring · uuid

typestringrequired

one of "scope:project", "threshold:feedback_score", "threshold:cost", "threshold:latency", "threshold:errors", "filter:guardrail_type"

webhookobjectrequired

Show child attributes

headersobject

idstring · uuid

namestring

secret_tokenstring

maxLength 250 · minLength 0

urlstringrequired

minLength 1

Example request

{
  "alert_type": "general",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {
    "additionalProp1": "string"
  },
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "triggers": [
    {
      "event_type": "experiment:finished",
      "id": "00000000-0000-0000-0000-000000000000",
      "trigger_configs": [
        {
          "config_value": {
            "additionalProp1": "string"
          },
          "group_index": 0,
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "filter:guardrail_type"
        }
      ]
    }
  ],
  "webhook": {
    "headers": {
      "additionalProp1": "string"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "secret_token": "string",
    "url": "string"
  }
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

idrequiredpath parameter

curl -X PUT 'http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"alert_type":"general","enabled":true,"id":"00000000-0000-0000-0000-000000000000","metadata":{"additionalProp1":"string"},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","triggers":[{"event_type":"experiment:finished","id":"00000000-0000-0000-0000-000000000000","trigger_configs":[{"config_value":{"additionalProp1":"string"},"group_index":0,"id":"00000000-0000-0000-0000-000000000000","type":"filter:guardrail_type"}]}],"webhook":{"headers":{"additionalProp1":"string"},"id":"00000000-0000-0000-0000-000000000000","name":"string","secret_token":"string","url":"string"}}'

const response = await fetch('http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"alert_type":"general","enabled":true,"id":"00000000-0000-0000-0000-000000000000","metadata":{"additionalProp1":"string"},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","triggers":[{"event_type":"experiment:finished","id":"00000000-0000-0000-0000-000000000000","trigger_configs":[{"config_value":{"additionalProp1":"string"},"group_index":0,"id":"00000000-0000-0000-0000-000000000000","type":"filter:guardrail_type"}]}],"webhook":{"headers":{"additionalProp1":"string"},"id":"00000000-0000-0000-0000-000000000000","name":"string","secret_token":"string","url":"string"}}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"alert_type\":\"general\",\"enabled\":true,\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"triggers\":[{\"event_type\":\"experiment:finished\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"trigger_configs\":[{\"config_value\":{\"additionalProp1\":\"string\"},\"group_index\":0,\"id\":\"00000000-0000-0000-0000-000000000000\",\"type\":\"filter:guardrail_type\"}]}],\"webhook\":{\"headers\":{\"additionalProp1\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"string\",\"secret_token\":\"string\",\"url\":\"string\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"alert_type":"general","enabled":true,"id":"00000000-0000-0000-0000-000000000000","metadata":{"additionalProp1":"string"},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","triggers":[{"event_type":"experiment:finished","id":"00000000-0000-0000-0000-000000000000","trigger_configs":[{"config_value":{"additionalProp1":"string"},"group_index":0,"id":"00000000-0000-0000-0000-000000000000","type":"filter:guardrail_type"}]}],"webhook":{"headers":{"additionalProp1":"string"},"id":"00000000-0000-0000-0000-000000000000","name":"string","secret_token":"string","url":"string"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"alert_type":"general","enabled":true,"id":"00000000-0000-0000-0000-000000000000","metadata":{"additionalProp1":"string"},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","triggers":[{"event_type":"experiment:finished","id":"00000000-0000-0000-0000-000000000000","trigger_configs":[{"config_value":{"additionalProp1":"string"},"group_index":0,"id":"00000000-0000-0000-0000-000000000000","type":"filter:guardrail_type"}]}],"webhook":{"headers":{"additionalProp1":"string"},"id":"00000000-0000-0000-0000-000000000000","name":"string","secret_token":"string","url":"string"}}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"alert_type\":\"general\",\"enabled\":true,\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"triggers\":[{\"event_type\":\"experiment:finished\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"trigger_configs\":[{\"config_value\":{\"additionalProp1\":\"string\"},\"group_index\":0,\"id\":\"00000000-0000-0000-0000-000000000000\",\"type\":\"filter:guardrail_type\"}]}],\"webhook\":{\"headers\":{\"additionalProp1\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"string\",\"secret_token\":\"string\",\"url\":\"string\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"alert_type\":\"general\",\"enabled\":true,\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"triggers\":[{\"event_type\":\"experiment:finished\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"trigger_configs\":[{\"config_value\":{\"additionalProp1\":\"string\"},\"group_index\":0,\"id\":\"00000000-0000-0000-0000-000000000000\",\"type\":\"filter:guardrail_type\"}]}],\"webhook\":{\"headers\":{\"additionalProp1\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"string\",\"secret_token\":\"string\",\"url\":\"string\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"alert_type\":\"general\",\"enabled\":true,\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"triggers\":[{\"event_type\":\"experiment:finished\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"trigger_configs\":[{\"config_value\":{\"additionalProp1\":\"string\"},\"group_index\":0,\"id\":\"00000000-0000-0000-0000-000000000000\",\"type\":\"filter:guardrail_type\"}]}],\"webhook\":{\"headers\":{\"additionalProp1\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"string\",\"secret_token\":\"string\",\"url\":\"string\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "http://localhost:5173/api/v1/private/alerts/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"alert_type\":\"general\",\"enabled\":true,\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"triggers\":[{\"event_type\":\"experiment:finished\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"trigger_configs\":[{\"config_value\":{\"additionalProp1\":\"string\"},\"group_index\":0,\"id\":\"00000000-0000-0000-0000-000000000000\",\"type\":\"filter:guardrail_type\"}]}],\"webhook\":{\"headers\":{\"additionalProp1\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"name\":\"string\",\"secret_token\":\"string\",\"url\":\"string\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}