Create a webhook
Create a new webhook in an organization.
Payload Requirements
organization_id,name, andurlare required.- The webhook name must be unique within the organization (409 on conflict).
auth_typeis optional, defaults toBEARER, and cannot be changed after creation.auth_tokenis only valid whenauth_typeisBEARER, and is write-only — it is never returned in any response.timeout_msis optional, defaults to 30000, and must be between 1000 and 60000.headersis optional and holds at most 20 entries; header names must be valid HTTP header names, and connection-management headers are rejected. Write-only: header values are never returned.- System-managed fields (
id,created_at,updated_at) are generated automatically and rejected if provided.
For HMAC_SHA256 webhooks, a signing secret is generated and returned
in this response — the only time it is ever returned. Store it
securely: only a redacted hint is readable afterwards, and losing the
secret means deleting and recreating the webhook.
Authorizations
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Service accounts may instead present an access token issued by an external identity provider (Microsoft Entra ID) when the account admin has configured that provider. Send it in the same header: Authorization: Bearer <access-token>.
Body
Body containing webhook creation parameters
Response
The created webhook. For HMAC_SHA256 webhooks the response includes
signing_secret — the only time it is ever returned.
The created webhook, plus signing_secret for HMAC_SHA256 webhooks —
the only time the secret is ever returned.
Was this page helpful?