# Get webhook payload examples

GET http://localhost:5173/api/v1/private/alerts/webhooks/examples

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

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

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get webhook payload examples
  version: endpoint_alerts.getWebhookExamples
paths:
  /v1/private/alerts/webhooks/examples:
    get:
      operationId: get-webhook-examples
      summary: Get webhook payload examples
      description: >-
        Get webhook payload examples for all alert event types, optionally
        filtered by alert type
      tags:
        - - subpackage_alerts
      parameters:
        - name: alert_type
          in: query
          required: false
          schema:
            $ref: >-
              #/components/schemas/V1PrivateAlertsWebhooksExamplesGetParametersAlertType
      responses:
        '200':
          description: Webhook examples
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookExamples'
components:
  schemas:
    V1PrivateAlertsWebhooksExamplesGetParametersAlertType:
      type: string
      enum:
        - value: general
        - value: slack
        - value: pagerduty
    WebhookExamplesResponseExamples:
      type: object
      properties: {}
    WebhookExamples:
      type: object
      properties:
        response_examples:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/WebhookExamplesResponseExamples'

```

## SDK Code Examples

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/alerts/webhooks/examples';
const options = {method: 'GET'};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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/examples")

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

request = Net::HTTP::Get.new(url)

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

```java
HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/alerts/webhooks/examples")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/alerts/webhooks/examples');

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

```csharp
var client = new RestClient("http://localhost:5173/api/v1/private/alerts/webhooks/examples");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/alerts/webhooks/examples")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```