Get Alert by id | Opik Documentation

curl http://localhost:5173/api/v1/private/alerts/id \
     -H "Content-Type: application/json"

{
  "webhook": {
    "url": "https://hooks.example.com/alerts/error",
    "id": "7b9c9f1a-8d3e-4f2a-9a1b-2d4f5e6a7b8c",
    "name": "Error Notifications Webhook",
    "secret_token": "s3cr3tT0k3n123",
    "headers": {
      "Authorization": "Bearer abcdef123456",
      "Content-Type": "application/json"
    },
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "alice@example.com",
    "last_updated_at": "2024-04-10T11:45:00Z",
    "last_updated_by": "bob@example.com"
  },
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "High Error Rate Alert",
  "enabled": true,
  "alert_type": "general",
  "metadata": {
    "severity": "high",
    "owner": "dev-team"
  },
  "triggers": [
    {
      "event_type": "trace:errors",
      "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
      "alert_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "trigger_configs": [
        {
          "type": "scope:project",
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "alert_trigger_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
          "config_value": {
            "project": "opik-backend"
          },
          "created_at": "2024-01-15T09:30:00Z",
          "created_by": "alice@example.com",
          "last_updated_at": "2024-04-10T11:45:00Z",
          "last_updated_by": "bob@example.com"
        }
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "alice@example.com"
    }
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "alice@example.com",
  "last_updated_at": "2024-04-10T11:45:00Z",
  "last_updated_by": "bob@example.com",
  "project_id": "9f8e7d6c-5b4a-3210-9f8e-7d6c5b4a3210"
}

Get Alert by id

Path parameters

idstringRequiredformat: "uuid"

Response

Alert resource

webhookobject

idstringformat: "uuid"

namestring0-255 characters

enabledboolean

alert_typeenum

Allowed values:

metadatamap from strings to strings

triggerslist of objects

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetimeRead-only

last_updated_bystringRead-only

project_idstringformat: "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.

Errors

404

Not Found Error