Implementation:Openai Openai python Response Completed Webhook
| Knowledge Sources | |
|---|---|
| Domains | API_Types, Python |
| Last Updated | 2026-02-15 00:00 GMT |
Overview
Concrete type for representing a response completed webhook event provided by the openai-python SDK.
Description
ResponseCompletedWebhookEvent is a Pydantic model class that represents the webhook payload sent when a background response has been completed. It extends BaseModel and includes an event identifier, a Unix timestamp for when the completion occurred, a nested Data payload containing the model response ID, a literal type field fixed to "response.completed", and an optional object field fixed to "event".
Usage
Import this type when building a webhook handler that needs to process background response completion events from the OpenAI API. Use it to deserialize incoming webhook payloads and trigger retrieval of the completed response content.
Code Reference
Source Location
- Repository: openai-python
- File: src/openai/types/webhooks/response_completed_webhook_event.py
Signature
class Data(BaseModel):
"""Event data payload."""
id: str
class ResponseCompletedWebhookEvent(BaseModel):
"""Sent when a background response has been completed."""
id: str
created_at: int
data: Data
type: Literal["response.completed"]
object: Optional[Literal["event"]] = None
Import
from openai.types.webhooks import ResponseCompletedWebhookEvent
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 model response was completed. |
| data | Data | Yes | Event data payload containing the model response ID. |
| data.id | str | Yes | The unique ID of the model response. |
| type | Literal["response.completed"] | Yes | The type of the event. Always "response.completed". |
| object | Optional[Literal["event"]] | No | The object of the event. Always "event" when present. |
Usage Examples
from openai.types.webhooks import ResponseCompletedWebhookEvent
# Parse a webhook payload
event = ResponseCompletedWebhookEvent.model_validate(payload)
print(f"Response {event.data.id} completed at {event.created_at}")
print(f"Event type: {event.type}") # "response.completed"