Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Test Webhook Endpoint

webhooks.test(webhook_endpoint_id, **kwargs) -> WebhookEndpointTestResult
POST
/webhook_endpoints/{webhook_endpoint_id}/test

Sends a sample event to a webhook endpoint for the authenticated project.

Parameters
webhook_endpoint_id: str
event_type: Literal["batch.completed", "batch.failed", "batch.expired", 24 more]

The event type to send as a sample delivery.

Returns
class WebhookEndpointTestResult: …
event_type: str

The event type sent in the test.

object: Literal["webhook_endpoint.test"]

The object type, which is always webhook_endpoint.test.

status_code: int

The HTTP status code returned by the endpoint.

success: Literal[true]

Whether the test request completed. Always true for returned results; use status_code to determine the endpoint response.

webhook_endpoint_id: str

The ID of the webhook endpoint that received the test.

Test Webhook Endpoint

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
webhook_endpoint_test_result = client.webhooks.test(
    webhook_endpoint_id="whe_123",
    event_type="batch.completed",
)
print(webhook_endpoint_test_result.webhook_endpoint_id)
200 — Example
{
  "event_type": "event_type",
  "object": "webhook_endpoint.test",
  "status_code": 0,
  "success": true,
  "webhook_endpoint_id": "webhook_endpoint_id"
}
Returns Examples
200 — Example
{
  "event_type": "event_type",
  "object": "webhook_endpoint.test",
  "status_code": 0,
  "success": true,
  "webhook_endpoint_id": "webhook_endpoint_id"
}