Webhooks

Send a test event to a webhook

Changed on

Send a test event to the webhook's endpoint and report the outcome. Use this to verify the endpoint is reachable and accepts deliveries before subscribing the webhook to real events.

A 200 response means the test ran — check status_code and error_message in the body for the endpoint's actual outcome. A 404 means the destination was not available to receive a test. A 503 means the test could not be sent; retry later.

Test deliveries are not supported for HMAC_SHA256 webhooks; those requests fail with a 400.

<Warning>This endpoint is in alpha, read more here.</Warning>

post/v2/webhooks/{webhook_id}/test

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/webhooks/{webhook_id}/test
  • Auth
    HTTP bearer

Path parameters

webhook_idstring required

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

Example:RW50aXR5OjEyMzQ1

The unique webhook identifier (base64)

Response

The outcome of the test delivery

status_codeinteger required

HTTP status code returned by the webhook's endpoint. 502 when no response was received, for example because the endpoint was unreachable or timed out.

error_messagestring nullable required

Why the test delivery failed. null for successful deliveries.

Changes