Get webhook payload examples | Opik Documentation

GET/v1/private/alerts/webhooks/examplesGet webhook payload examples

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

Parameters

alert_typestringquery

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

Responses

objectWebhookExamples

response_examplesobject

Example response

{
  "response_examples": {
    "additionalProp1": {}
  }
}

Examples

alert_typequery parameter

curl -X GET 'http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general'

const response = await fetch('http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general", nil)
	if err != nil {
		panic(err)
	}
	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/webhooks/examples?alert_type=general");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "http://localhost:5173/api/v1/private/alerts/webhooks/examples?alert_type=general");
using var response = await client.SendAsync(request);

{
  "response_examples": {
    "additionalProp1": {}
  }
}