Implementation:Openai Openai python Eval Run Canceled Webhook

Knowledge Sources	Openai_Openai_python OpenAI API Reference
Domains	API_Types, Python
Last Updated	2026-02-15 00:00 GMT

Overview

Concrete type for representing an eval run canceled webhook event provided by the openai-python SDK.

Description

EvalRunCanceledWebhookEvent is a Pydantic model class that represents the webhook payload sent when an evaluation run has been canceled. It extends BaseModel and includes an event identifier, a Unix timestamp for when the cancellation occurred, a nested Data payload containing the eval run ID, a literal type field fixed to "eval.run.canceled", and an optional object field fixed to "event".

Usage

Import this type when building a webhook handler that needs to process eval run cancellation events from the OpenAI API. Use it to deserialize incoming webhook payloads and extract the eval run ID and event metadata.

Code Reference

Source Location

• Repository: openai-python
• File: src/openai/types/webhooks/eval_run_canceled_webhook_event.py

Signature

class Data(BaseModel):
    """Event data payload."""
    id: str

class EvalRunCanceledWebhookEvent(BaseModel):
    """Sent when an eval run has been canceled."""
    id: str
    created_at: int
    data: Data
    type: Literal["eval.run.canceled"]
    object: Optional[Literal["event"]] = None

Import

from openai.types.webhooks import EvalRunCanceledWebhookEvent

I/O Contract

Fields

Name	Type	Required	Description
id	str	Yes	The unique ID of the event.
created_at	int	Yes	Unix timestamp (in seconds) of when the eval run was canceled.
data	Data	Yes	Event data payload containing the eval run ID.
data.id	str	Yes	The unique ID of the eval run.
type	Literal["eval.run.canceled"]	Yes	The type of the event. Always "eval.run.canceled".
object	Optional[Literal["event"]]	No	The object of the event. Always "event" when present.

Usage Examples

from openai.types.webhooks import EvalRunCanceledWebhookEvent

# Parse a webhook payload
event = EvalRunCanceledWebhookEvent.model_validate(payload)
print(f"Eval run {event.data.id} was canceled at {event.created_at}")
print(f"Event type: {event.type}")  # "eval.run.canceled"

Related Pages

• Environment:Openai_Openai_python_Python_3_9_Plus