Get a webhook

curl --request GET \
  --url https://api.arize.com/v2/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arize.com/v2/webhooks/{webhook_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.arize.com/v2/webhooks/{webhook_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/webhooks/{webhook_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "V2ViaG9vazoxMjM0NQ==",
  "organization_id": "T3JnYW5pemF0aW9uOjEyMzQ1",
  "name": "Prompt release notifications",
  "description": "Notifies the deploy pipeline when a prompt version is labeled",
  "url": "https://example.com/hooks/arize",
  "auth_type": "HMAC_SHA256",
  "signing_secret_hint": "whsec_…abcd",
  "timeout_ms": 30000,
  "headers": {
    "X-Environment": "production"
  },
  "created_at": "2026-08-01T12:00:00Z",
  "updated_at": "2026-08-01T12:00:00Z",
  "created_by_user_id": "VXNlcjoxMjM0NQ=="
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

GET

webhooks

{webhook_id}

Get a webhook

curl --request GET \
  --url https://api.arize.com/v2/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arize.com/v2/webhooks/{webhook_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arize.com/v2/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.arize.com/v2/webhooks/{webhook_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arize.com/v2/webhooks/{webhook_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "V2ViaG9vazoxMjM0NQ==",
  "organization_id": "T3JnYW5pemF0aW9uOjEyMzQ1",
  "name": "Prompt release notifications",
  "description": "Notifies the deploy pipeline when a prompt version is labeled",
  "url": "https://example.com/hooks/arize",
  "auth_type": "HMAC_SHA256",
  "signing_secret_hint": "whsec_…abcd",
  "timeout_ms": 30000,
  "headers": {
    "X-Environment": "production"
  },
  "created_at": "2026-08-01T12:00:00Z",
  "updated_at": "2026-08-01T12:00:00Z",
  "created_by_user_id": "VXNlcjoxMjM0NQ=="
}

{
  "status": 400,
  "title": "Invalid request parameters",
  "detail": "The 'name' field is required and must be a non-empty string.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}

{
  "status": 401,
  "title": "Authentication required",
  "detail": "You must be authenticated to access this resource.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}

{
  "status": 404,
  "title": "Resource not found",
  "detail": "The requested resource with ID '12345' was not found.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}

{
  "status": 429,
  "title": "Rate limit exceeded",
  "detail": "You have exceeded the allowed number of requests. Please try again later.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}

Authorizations

Authorization

string

header

required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

webhook_id

string

required

The unique webhook identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Response

A webhook object

A webhook is an organization-owned destination that receives event deliveries over HTTPS. Attach a webhook to prompts and evaluators through their webhook-subscription endpoints to choose which events it receives.

Credentials are write-only: the bearer token is never returned, and the HMAC signing secret is returned exactly once, in the create response — only its redacted hint is readable afterwards.

string

required

Unique identifier for the webhook

Example:

"RW50aXR5OjEyMzQ1"

organization_id

string

required

The unique identifier of the organization that owns the webhook

Example:

"RW50aXR5OjEyMzQ1"

name

string

required

Name of the webhook (unique within the organization)

Maximum string length: 255

description

string

required

A brief description of the webhook's purpose. Defaults to an empty string.

url

string<uri>

required

The HTTPS endpoint events are delivered to

auth_type

enum<string>

required

How deliveries from this webhook are authenticated. Fixed at creation.

Available options:

BEARER,

HMAC_SHA256

timeout_ms

integer

required

How long a delivery request may run before it is abandoned, in milliseconds. Defaults to 30000.

Required range: 1000 <= x <= 60000

headers

object

required

Custom HTTP headers sent with each delivery request

Show child attributes

created_at

string<date-time>

required

Timestamp for when the webhook was created

updated_at

string<date-time>

required

Timestamp for when the webhook was last updated

signing_secret_hint

string

Redacted hint of the signing secret (e.g. whsec_…abcd), useful for identifying which secret the webhook uses. Present only for HMAC_SHA256 webhooks. The full secret is returned exactly once, in the create response, and cannot be retrieved afterwards.

created_by_user_id

string

The unique identifier of the user who created the webhook. Absent when that user has since been removed from the account.

Example:

"RW50aXR5OjEyMzQ1"

Skills

API reference

API clients

Get a webhook

Authorizations

Path Parameters

Response