> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Test alert webhook

POST http://localhost:5173/api/v1/private/alerts/webhooks/tests
Content-Type: application/json

Test alert webhook

Reference: https://www.comet.com/docs/opik/reference/rest-api/alerts/test-webhook

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Body (application/json)

This endpoint expects an Alert_Write.

- `webhook` (Webhook_Write, required)
- `id` (string, optional)
- `name` (string, optional)
- `enabled` (boolean, optional)
- `alert_type` (enum, optional)
  - Allowed values: `general`, `slack`, `pagerduty`
- `metadata` (map from string to string, optional)
- `triggers` (list of AlertTrigger_Write, optional)
- `project_id` (string, optional) — 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.

## Response

### 200

Webhook test

- `status` (enum, optional)
  - Allowed values: `success`, `failure`
- `status_code` (integer, optional)
- `request_body` (string, optional)
- `error_message` (string, optional)

## Errors

### 422 Unprocessable Entity Error

Unprocessable Content

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### Webhook_Write

- `url` (string, required)
- `id` (string, optional)
- `name` (string, optional)
- `secret_token` (string, optional)
- `headers` (map from string to string, optional)

### AlertTrigger_Write

- `event_type` (enum, required)
  - Allowed values: `trace:errors`, `trace:feedback_score`, `trace_thread:feedback_score`, `prompt:created`, `prompt:committed`, `trace:guardrails_triggered`, `prompt:deleted`, `experiment:finished`, `trace:cost`, `trace:latency`
- `id` (string, optional)
- `trigger_configs` (list of AlertTriggerConfig_Write, optional)

### AlertTriggerConfig_Write

- `type` (enum, required)
  - Allowed values: `scope:project`, `threshold:feedback_score`, `threshold:cost`, `threshold:latency`, `threshold:errors`, `filter:guardrail_type`
- `id` (string, optional)
- `config_value` (map from string to string, optional)
- `group_index` (integer, optional) — 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.

## Examples

**Request**

```json
{
  "webhook": {
    "url": "string"
  }
}
```

**Response**

```json
{
  "status": "success",
  "status_code": 1,
  "request_body": "string",
  "error_message": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/alerts/webhooks/tests"

payload = { "webhook": { "url": "string" } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/alerts/webhooks/tests';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"webhook":{"url":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/alerts/webhooks/tests"

	payload := strings.NewReader("{\n  \"webhook\": {\n    \"url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/alerts/webhooks/tests")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhook\": {\n    \"url\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:5173/api/v1/private/alerts/webhooks/tests")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhook\": {\n    \"url\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/alerts/webhooks/tests', [
  'body' => '{
  "webhook": {
    "url": "string"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/alerts/webhooks/tests");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"webhook\": {\n    \"url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["webhook": ["url": "string"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/alerts/webhooks/tests")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```