Update a webhook

curl --request PATCH \
  --url https://api.arize.com/v2/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Prompt release notifications (staging)",
  "timeout_ms": 10000
}
'

import requests

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

payload = {
    "name": "Prompt release notifications (staging)",
    "timeout_ms": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Prompt release notifications (staging)', timeout_ms: 10000})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Prompt release notifications (staging)',
    'timeout_ms' => 10000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/webhooks/{webhook_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}"

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": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "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": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "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"
}

Webhooks

Update a webhook

Update a webhook by its ID. At least one field must be provided.

Payload Requirements

At least one of name, description, url, auth_token, timeout_ms, or headers must be provided.
If name is provided, it must be unique within the organization (409 on conflict).
headers replaces the whole header map.
auth_type cannot be changed after creation, and the signing secret of an HMAC_SHA256 webhook cannot be rotated — create a new webhook instead.
System-managed fields (id, created_at, updated_at) cannot be modified.

This endpoint is in alpha, read more here.

PATCH

webhooks

{webhook_id}

Update a webhook

curl --request PATCH \
  --url https://api.arize.com/v2/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Prompt release notifications (staging)",
  "timeout_ms": 10000
}
'

import requests

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

payload = {
    "name": "Prompt release notifications (staging)",
    "timeout_ms": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Prompt release notifications (staging)', timeout_ms: 10000})
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Prompt release notifications (staging)',
    'timeout_ms' => 10000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.arize.com/v2/webhooks/{webhook_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}")
  .asString();

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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Prompt release notifications (staging)\",\n  \"timeout_ms\": 10000\n}"

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": 403,
  "title": "Access forbidden",
  "detail": "You do not have permission to access this resource.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}

{
  "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": 409,
  "title": "Resource conflict",
  "detail": "A resource with the given identifier already exists.",
  "instance": "/resource",
  "type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}

{
  "status": 422,
  "title": "Unprocessable Entity",
  "detail": "One or more fields failed validation.",
  "instance": "/resource/12345",
  "type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}

{
  "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"

Body

application/json

Body containing webhook update parameters. At least one field must be provided.

name

string

Updated name of the webhook (must be unique within the organization)

Maximum string length: 255

description

string | null

Updated description of the webhook. Set to null to clear it.

url

string<uri>

Updated HTTPS endpoint events are delivered to

auth_token

string

Replacement Authorization header value sent with each delivery request, e.g. Bearer my-token. Sent verbatim — include the Bearer prefix if your endpoint expects one. Only valid when the webhook's auth_type is BEARER. Write-only: never returned in any response.

timeout_ms

integer

Updated delivery timeout in milliseconds

Required range: 1000 <= x <= 60000

headers

object

Replacement custom HTTP headers, as a map of at most 20 header names to values. Replaces the whole header map; headers not included are removed.

Show child attributes

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

Update a webhook

Authorizations

Path Parameters

Body

Response