Webhooks

webhooks.unwrap()

**** ``

Validates that the given payload was sent by OpenAI and parses the payload.

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
client.webhooks.unwrap()

Domain Types

Batch Cancelled Webhook Event

class BatchCancelledWebhookEvent: …

Sent when a batch API request has been cancelled.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the batch API request was cancelled.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the batch API request.
- type: Literal["batch.cancelled"]
  
  The type of the event. Always batch.cancelled.
  - "batch.cancelled"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Batch Completed Webhook Event

class BatchCompletedWebhookEvent: …

Sent when a batch API request has been completed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the batch API request was completed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the batch API request.
- type: Literal["batch.completed"]
  
  The type of the event. Always batch.completed.
  - "batch.completed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Batch Expired Webhook Event

class BatchExpiredWebhookEvent: …

Sent when a batch API request has expired.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the batch API request expired.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the batch API request.
- type: Literal["batch.expired"]
  
  The type of the event. Always batch.expired.
  - "batch.expired"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Batch Failed Webhook Event

class BatchFailedWebhookEvent: …

Sent when a batch API request has failed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the batch API request failed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the batch API request.
- type: Literal["batch.failed"]
  
  The type of the event. Always batch.failed.
  - "batch.failed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Eval Run Canceled Webhook Event

class EvalRunCanceledWebhookEvent: …

Sent when an eval run has been canceled.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the eval run was canceled.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the eval run.
- type: Literal["eval.run.canceled"]
  
  The type of the event. Always eval.run.canceled.
  - "eval.run.canceled"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Eval Run Failed Webhook Event

class EvalRunFailedWebhookEvent: …

Sent when an eval run has failed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the eval run failed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the eval run.
- type: Literal["eval.run.failed"]
  
  The type of the event. Always eval.run.failed.
  - "eval.run.failed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Eval Run Succeeded Webhook Event

class EvalRunSucceededWebhookEvent: …

Sent when an eval run has succeeded.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the eval run succeeded.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the eval run.
- type: Literal["eval.run.succeeded"]
  
  The type of the event. Always eval.run.succeeded.
  - "eval.run.succeeded"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Fine Tuning Job Cancelled Webhook Event

class FineTuningJobCancelledWebhookEvent: …

Sent when a fine-tuning job has been cancelled.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the fine-tuning job.
- type: Literal["fine_tuning.job.cancelled"]
  
  The type of the event. Always fine_tuning.job.cancelled.
  - "fine_tuning.job.cancelled"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Fine Tuning Job Failed Webhook Event

class FineTuningJobFailedWebhookEvent: …

Sent when a fine-tuning job has failed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the fine-tuning job failed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the fine-tuning job.
- type: Literal["fine_tuning.job.failed"]
  
  The type of the event. Always fine_tuning.job.failed.
  - "fine_tuning.job.failed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Fine Tuning Job Succeeded Webhook Event

class FineTuningJobSucceededWebhookEvent: …

Sent when a fine-tuning job has succeeded.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the fine-tuning job.
- type: Literal["fine_tuning.job.succeeded"]
  
  The type of the event. Always fine_tuning.job.succeeded.
  - "fine_tuning.job.succeeded"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Realtime Call Incoming Webhook Event

class RealtimeCallIncomingWebhookEvent: …

Sent when Realtime API Receives a incoming SIP call.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the model response was completed.
- data: Data
  
  Event data payload.
  - call_id: str
    
    The unique ID of this call.
  - sip_headers: List[DataSipHeader]
    
    Headers from the SIP Invite.
    - name: str
      
      Name of the SIP Header.
    - value: str
      
      Value of the SIP Header.
- type: Literal["realtime.call.incoming"]
  
  The type of the event. Always realtime.call.incoming.
  - "realtime.call.incoming"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Response Cancelled Webhook Event

class ResponseCancelledWebhookEvent: …

Sent when a background response has been cancelled.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the model response was cancelled.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the model response.
- type: Literal["response.cancelled"]
  
  The type of the event. Always response.cancelled.
  - "response.cancelled"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Response Completed Webhook Event

class ResponseCompletedWebhookEvent: …

Sent when a background response has been completed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the model response was completed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the model response.
- type: Literal["response.completed"]
  
  The type of the event. Always response.completed.
  - "response.completed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Response Failed Webhook Event

class ResponseFailedWebhookEvent: …

Sent when a background response has failed.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the model response failed.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the model response.
- type: Literal["response.failed"]
  
  The type of the event. Always response.failed.
  - "response.failed"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Response Incomplete Webhook Event

class ResponseIncompleteWebhookEvent: …

Sent when a background response has been interrupted.
- id: str
  
  The unique ID of the event.
- created_at: int
  
  The Unix timestamp (in seconds) of when the model response was interrupted.
- data: Data
  
  Event data payload.
  - id: str
    
    The unique ID of the model response.
- type: Literal["response.incomplete"]
  
  The type of the event. Always response.incomplete.
  - "response.incomplete"
- object: Optional[Literal["event"]]
  
  The object of the event. Always event.
  - "event"

Unwrap Webhook Event

UnwrapWebhookEvent

Sent when a batch API request has been cancelled.
- class BatchCancelledWebhookEvent: …
  
  Sent when a batch API request has been cancelled.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the batch API request was cancelled.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the batch API request.
  - type: Literal["batch.cancelled"]
    
    The type of the event. Always batch.cancelled.
    - "batch.cancelled"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class BatchCompletedWebhookEvent: …
  
  Sent when a batch API request has been completed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the batch API request was completed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the batch API request.
  - type: Literal["batch.completed"]
    
    The type of the event. Always batch.completed.
    - "batch.completed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class BatchExpiredWebhookEvent: …
  
  Sent when a batch API request has expired.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the batch API request expired.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the batch API request.
  - type: Literal["batch.expired"]
    
    The type of the event. Always batch.expired.
    - "batch.expired"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class BatchFailedWebhookEvent: …
  
  Sent when a batch API request has failed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the batch API request failed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the batch API request.
  - type: Literal["batch.failed"]
    
    The type of the event. Always batch.failed.
    - "batch.failed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class EvalRunCanceledWebhookEvent: …
  
  Sent when an eval run has been canceled.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the eval run was canceled.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the eval run.
  - type: Literal["eval.run.canceled"]
    
    The type of the event. Always eval.run.canceled.
    - "eval.run.canceled"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class EvalRunFailedWebhookEvent: …
  
  Sent when an eval run has failed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the eval run failed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the eval run.
  - type: Literal["eval.run.failed"]
    
    The type of the event. Always eval.run.failed.
    - "eval.run.failed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class EvalRunSucceededWebhookEvent: …
  
  Sent when an eval run has succeeded.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the eval run succeeded.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the eval run.
  - type: Literal["eval.run.succeeded"]
    
    The type of the event. Always eval.run.succeeded.
    - "eval.run.succeeded"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class FineTuningJobCancelledWebhookEvent: …
  
  Sent when a fine-tuning job has been cancelled.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the fine-tuning job.
  - type: Literal["fine_tuning.job.cancelled"]
    
    The type of the event. Always fine_tuning.job.cancelled.
    - "fine_tuning.job.cancelled"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class FineTuningJobFailedWebhookEvent: …
  
  Sent when a fine-tuning job has failed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the fine-tuning job failed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the fine-tuning job.
  - type: Literal["fine_tuning.job.failed"]
    
    The type of the event. Always fine_tuning.job.failed.
    - "fine_tuning.job.failed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class FineTuningJobSucceededWebhookEvent: …
  
  Sent when a fine-tuning job has succeeded.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the fine-tuning job.
  - type: Literal["fine_tuning.job.succeeded"]
    
    The type of the event. Always fine_tuning.job.succeeded.
    - "fine_tuning.job.succeeded"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class RealtimeCallIncomingWebhookEvent: …
  
  Sent when Realtime API Receives a incoming SIP call.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - data: Data
    
    Event data payload.
    - call_id: str
      
      The unique ID of this call.
    - sip_headers: List[DataSipHeader]
      
      Headers from the SIP Invite.
      - name: str
        
        Name of the SIP Header.
      - value: str
        
        Value of the SIP Header.
  - type: Literal["realtime.call.incoming"]
    
    The type of the event. Always realtime.call.incoming.
    - "realtime.call.incoming"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class ResponseCancelledWebhookEvent: …
  
  Sent when a background response has been cancelled.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the model response was cancelled.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the model response.
  - type: Literal["response.cancelled"]
    
    The type of the event. Always response.cancelled.
    - "response.cancelled"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class ResponseCompletedWebhookEvent: …
  
  Sent when a background response has been completed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the model response.
  - type: Literal["response.completed"]
    
    The type of the event. Always response.completed.
    - "response.completed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class ResponseFailedWebhookEvent: …
  
  Sent when a background response has failed.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the model response failed.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the model response.
  - type: Literal["response.failed"]
    
    The type of the event. Always response.failed.
    - "response.failed"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"
- class ResponseIncompleteWebhookEvent: …
  
  Sent when a background response has been interrupted.
  - id: str
    
    The unique ID of the event.
  - created_at: int
    
    The Unix timestamp (in seconds) of when the model response was interrupted.
  - data: Data
    
    Event data payload.
    - id: str
      
      The unique ID of the model response.
  - type: Literal["response.incomplete"]
    
    The type of the event. Always response.incomplete.
    - "response.incomplete"
  - object: Optional[Literal["event"]]
    
    The object of the event. Always event.
    - "event"

python/resources/webhooks/index.md +0 −98

544 544

545 - `"event"`545 - `"event"`

546 546

547### Safety Identifier Blocked Webhook Event

~~548~~

549- `class SafetyIdentifierBlockedWebhookEvent: …`

~~550~~

551 Sent when a request associated with a safety identifier has been blocked.

~~552~~

553 - `id: str`

~~554~~

555 The unique ID of the event.

~~556~~

557 - `created_at: int`

~~558~~

559 The Unix timestamp (in seconds) of when the request was blocked.

~~560~~

561 - `data: Data`

~~562~~

563 Event data payload.

~~564~~

565 - `safety_category: str`

~~566~~

567 The safety category that triggered the block, such as `bio` or `cyber`.

~~568~~

569 - `safety_identifier: str`

~~570~~

571 The stable safety identifier associated with the blocked request.

~~572~~

573 - `model: Optional[str]`

~~574~~

575 The model used for the blocked request, if available.

~~576~~

577 - `project_id: Optional[str]`

~~578~~

579 The project associated with the blocked request, if available.

~~580~~

581 - `request_id: Optional[str]`

~~582~~

583 The OpenAI request ID for the blocked request, if available.

~~584~~

585 - `type: Literal["safety_identifier.blocked"]`

~~586~~

587 The type of the event. Always `safety_identifier.blocked`.

~~588~~

589 - `"safety_identifier.blocked"`

~~590~~

591 - `object: Optional[Literal["event"]]`

~~592~~

593 The object of the event. Always `event`.

~~594~~

595 - `"event"`

~~596~~

597### Unwrap Webhook Event547### Unwrap Webhook Event

598 548

599- `UnwrapWebhookEvent`549- `UnwrapWebhookEvent`

1091 The object of the event. Always `event`.1041 The object of the event. Always `event`.

1092 1042

1093 - `"event"`1043 - `"event"`

~~1094~~

1095 - `class SafetyIdentifierBlockedWebhookEvent: …`

~~1096~~

1097 Sent when a request associated with a safety identifier has been blocked.

~~1098~~

1099 - `id: str`

~~1100~~

1101 The unique ID of the event.

~~1102~~

1103 - `created_at: int`

~~1104~~

1105 The Unix timestamp (in seconds) of when the request was blocked.

~~1106~~

1107 - `data: Data`

~~1108~~

1109 Event data payload.

~~1110~~

1111 - `safety_category: str`

~~1112~~

1113 The safety category that triggered the block, such as `bio` or `cyber`.

~~1114~~

1115 - `safety_identifier: str`

~~1116~~

1117 The stable safety identifier associated with the blocked request.

~~1118~~

1119 - `model: Optional[str]`

~~1120~~

1121 The model used for the blocked request, if available.

~~1122~~

1123 - `project_id: Optional[str]`

~~1124~~

1125 The project associated with the blocked request, if available.

~~1126~~

1127 - `request_id: Optional[str]`

~~1128~~

1129 The OpenAI request ID for the blocked request, if available.

~~1130~~

1131 - `type: Literal["safety_identifier.blocked"]`

~~1132~~

1133 The type of the event. Always `safety_identifier.blocked`.

~~1134~~

1135 - `"safety_identifier.blocked"`

~~1136~~

1137 - `object: Optional[Literal["event"]]`

~~1138~~

1139 The object of the event. Always `event`.

~~1140~~

1141 - `"event"`