Skip to main content
PATCH
Update a webhook

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.

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.

id
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

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"