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, orheadersmust be provided. - If
nameis provided, it must be unique within the organization (409 on conflict). headersreplaces the whole header map.auth_typecannot be changed after creation, and the signing secret of anHMAC_SHA256webhook cannot be rotated — create a new webhook instead.- System-managed fields (
id,created_at,updated_at) cannot be modified.
Authorizations
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
The unique webhook identifier (base64) A universally unique identifier (base64-encoded opaque string).
"RW50aXR5OjEyMzQ1"
Body
Body containing webhook update parameters. At least one field must be provided.
Updated name of the webhook (must be unique within the organization)
255Updated description of the webhook. Set to null to clear it.
Updated HTTPS endpoint events are delivered to
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.
Updated delivery timeout in milliseconds
1000 <= x <= 60000Replacement 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.
Unique identifier for the webhook
"RW50aXR5OjEyMzQ1"
The unique identifier of the organization that owns the webhook
"RW50aXR5OjEyMzQ1"
Name of the webhook (unique within the organization)
255A brief description of the webhook's purpose. Defaults to an empty string.
The HTTPS endpoint events are delivered to
How deliveries from this webhook are authenticated. Fixed at creation.
BEARER, HMAC_SHA256 How long a delivery request may run before it is abandoned, in milliseconds. Defaults to 30000.
1000 <= x <= 60000Custom HTTP headers sent with each delivery request
Timestamp for when the webhook was created
Timestamp for when the webhook was last updated
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.
The unique identifier of the user who created the webhook. Absent when that user has since been removed from the account.
"RW50aXR5OjEyMzQ1"