Webhooks

Domain Types

Batch Cancelled Webhook Event

class BatchCancelledWebhookEvent:

Sent when a batch API request has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.cancelled"constant
  
  The type of the event. Always batch.cancelled.
  - BATCH_CANCELLED("batch.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Completed Webhook Event

class BatchCompletedWebhookEvent:

Sent when a batch API request has been completed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request was completed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.completed"constant
  
  The type of the event. Always batch.completed.
  - BATCH_COMPLETED("batch.completed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Expired Webhook Event

class BatchExpiredWebhookEvent:

Sent when a batch API request has expired.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request expired.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.expired"constant
  
  The type of the event. Always batch.expired.
  - BATCH_EXPIRED("batch.expired")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Failed Webhook Event

class BatchFailedWebhookEvent:

Sent when a batch API request has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.failed"constant
  
  The type of the event. Always batch.failed.
  - BATCH_FAILED("batch.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Canceled Webhook Event

class EvalRunCanceledWebhookEvent:

Sent when an eval run has been canceled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run was canceled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.canceled"constant
  
  The type of the event. Always eval.run.canceled.
  - EVAL_RUN_CANCELED("eval.run.canceled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Failed Webhook Event

class EvalRunFailedWebhookEvent:

Sent when an eval run has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.failed"constant
  
  The type of the event. Always eval.run.failed.
  - EVAL_RUN_FAILED("eval.run.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Succeeded Webhook Event

class EvalRunSucceededWebhookEvent:

Sent when an eval run has succeeded.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run succeeded.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.succeeded"constant
  
  The type of the event. Always eval.run.succeeded.
  - EVAL_RUN_SUCCEEDED("eval.run.succeeded")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Cancelled Webhook Event

class FineTuningJobCancelledWebhookEvent:

Sent when a fine-tuning job has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.cancelled"constant
  
  The type of the event. Always fine_tuning.job.cancelled.
  - FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Failed Webhook Event

class FineTuningJobFailedWebhookEvent:

Sent when a fine-tuning job has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.failed"constant
  
  The type of the event. Always fine_tuning.job.failed.
  - FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Succeeded Webhook Event

class FineTuningJobSucceededWebhookEvent:

Sent when a fine-tuning job has succeeded.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.succeeded"constant
  
  The type of the event. Always fine_tuning.job.succeeded.
  - FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Realtime Call Incoming Webhook Event

class RealtimeCallIncomingWebhookEvent:

Sent when Realtime API Receives a incoming SIP call.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was completed.
- Data data
  
  Event data payload.
  - String callId
    
    The unique ID of this call.
  - List<SipHeader> sipHeaders
    
    Headers from the SIP Invite.
    - String name
      
      Name of the SIP Header.
    - String value
      
      Value of the SIP Header.
- JsonValue; type "realtime.call.incoming"constant
  
  The type of the event. Always realtime.call.incoming.
  - REALTIME_CALL_INCOMING("realtime.call.incoming")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Cancelled Webhook Event

class ResponseCancelledWebhookEvent:

Sent when a background response has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.cancelled"constant
  
  The type of the event. Always response.cancelled.
  - RESPONSE_CANCELLED("response.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Completed Webhook Event

class ResponseCompletedWebhookEvent:

Sent when a background response has been completed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was completed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.completed"constant
  
  The type of the event. Always response.completed.
  - RESPONSE_COMPLETED("response.completed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Failed Webhook Event

class ResponseFailedWebhookEvent:

Sent when a background response has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.failed"constant
  
  The type of the event. Always response.failed.
  - RESPONSE_FAILED("response.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Incomplete Webhook Event

class ResponseIncompleteWebhookEvent:

Sent when a background response has been interrupted.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was interrupted.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.incomplete"constant
  
  The type of the event. Always response.incomplete.
  - RESPONSE_INCOMPLETE("response.incomplete")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Unwrap Webhook Event

class UnwrapWebhookEvent: A class that can be one of several variants.union

Sent when a batch API request has been cancelled.
- class BatchCancelledWebhookEvent:
  
  Sent when a batch API request has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.cancelled"constant
    
    The type of the event. Always batch.cancelled.
    - BATCH_CANCELLED("batch.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchCompletedWebhookEvent:
  
  Sent when a batch API request has been completed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request was completed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.completed"constant
    
    The type of the event. Always batch.completed.
    - BATCH_COMPLETED("batch.completed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchExpiredWebhookEvent:
  
  Sent when a batch API request has expired.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request expired.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.expired"constant
    
    The type of the event. Always batch.expired.
    - BATCH_EXPIRED("batch.expired")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchFailedWebhookEvent:
  
  Sent when a batch API request has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.failed"constant
    
    The type of the event. Always batch.failed.
    - BATCH_FAILED("batch.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunCanceledWebhookEvent:
  
  Sent when an eval run has been canceled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run was canceled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.canceled"constant
    
    The type of the event. Always eval.run.canceled.
    - EVAL_RUN_CANCELED("eval.run.canceled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunFailedWebhookEvent:
  
  Sent when an eval run has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.failed"constant
    
    The type of the event. Always eval.run.failed.
    - EVAL_RUN_FAILED("eval.run.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunSucceededWebhookEvent:
  
  Sent when an eval run has succeeded.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run succeeded.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.succeeded"constant
    
    The type of the event. Always eval.run.succeeded.
    - EVAL_RUN_SUCCEEDED("eval.run.succeeded")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobCancelledWebhookEvent:
  
  Sent when a fine-tuning job has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.cancelled"constant
    
    The type of the event. Always fine_tuning.job.cancelled.
    - FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobFailedWebhookEvent:
  
  Sent when a fine-tuning job has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.failed"constant
    
    The type of the event. Always fine_tuning.job.failed.
    - FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobSucceededWebhookEvent:
  
  Sent when a fine-tuning job has succeeded.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.succeeded"constant
    
    The type of the event. Always fine_tuning.job.succeeded.
    - FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class RealtimeCallIncomingWebhookEvent:
  
  Sent when Realtime API Receives a incoming SIP call.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - Data data
    
    Event data payload.
    - String callId
      
      The unique ID of this call.
    - List<SipHeader> sipHeaders
      
      Headers from the SIP Invite.
      - String name
        
        Name of the SIP Header.
      - String value
        
        Value of the SIP Header.
  - JsonValue; type "realtime.call.incoming"constant
    
    The type of the event. Always realtime.call.incoming.
    - REALTIME_CALL_INCOMING("realtime.call.incoming")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseCancelledWebhookEvent:
  
  Sent when a background response has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.cancelled"constant
    
    The type of the event. Always response.cancelled.
    - RESPONSE_CANCELLED("response.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseCompletedWebhookEvent:
  
  Sent when a background response has been completed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.completed"constant
    
    The type of the event. Always response.completed.
    - RESPONSE_COMPLETED("response.completed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseFailedWebhookEvent:
  
  Sent when a background response has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.failed"constant
    
    The type of the event. Always response.failed.
    - RESPONSE_FAILED("response.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseIncompleteWebhookEvent:
  
  Sent when a background response has been interrupted.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was interrupted.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.incomplete"constant
    
    The type of the event. Always response.incomplete.
    - RESPONSE_INCOMPLETE("response.incomplete")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")

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

524 524

525 - `EVENT("event")`525 - `EVENT("event")`

526 526

527### Safety Identifier Blocked Webhook Event

~~528~~

529- `class SafetyIdentifierBlockedWebhookEvent:`

~~530~~

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

~~532~~

533 - `String id`

~~534~~

535 The unique ID of the event.

~~536~~

537 - `long createdAt`

~~538~~

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

~~540~~

541 - `Data data`

~~542~~

543 Event data payload.

~~544~~

545 - `String safetyCategory`

~~546~~

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

~~548~~

549 - `String safetyIdentifier`

~~550~~

551 The stable safety identifier associated with the blocked request.

~~552~~

553 - `Optional<String> model`

~~554~~

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

~~556~~

557 - `Optional<String> projectId`

~~558~~

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

~~560~~

561 - `Optional<String> requestId`

~~562~~

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

~~564~~

565 - `JsonValue; type "safety_identifier.blocked"constant`

~~566~~

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

~~568~~

569 - `SAFETY_IDENTIFIER_BLOCKED("safety_identifier.blocked")`

~~570~~

571 - `Optional<Object> object_`

~~572~~

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

~~574~~

575 - `EVENT("event")`

~~576~~

577### Unwrap Webhook Event527### Unwrap Webhook Event

578 528

579- `class UnwrapWebhookEvent: A class that can be one of several variants.union`529- `class UnwrapWebhookEvent: A class that can be one of several variants.union`

1071 The object of the event. Always `event`.1021 The object of the event. Always `event`.

1072 1022

1073 - `EVENT("event")`1023 - `EVENT("event")`

~~1074~~

1075 - `class SafetyIdentifierBlockedWebhookEvent:`

~~1076~~

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

~~1078~~

1079 - `String id`

~~1080~~

1081 The unique ID of the event.

~~1082~~

1083 - `long createdAt`

~~1084~~

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

~~1086~~

1087 - `Data data`

~~1088~~

1089 Event data payload.

~~1090~~

1091 - `String safetyCategory`

~~1092~~

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

~~1094~~

1095 - `String safetyIdentifier`

~~1096~~

1097 The stable safety identifier associated with the blocked request.

~~1098~~

1099 - `Optional<String> model`

~~1100~~

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

~~1102~~

1103 - `Optional<String> projectId`

~~1104~~

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

~~1106~~

1107 - `Optional<String> requestId`

~~1108~~

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

~~1110~~

1111 - `JsonValue; type "safety_identifier.blocked"constant`

~~1112~~

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

~~1114~~

1115 - `SAFETY_IDENTIFIER_BLOCKED("safety_identifier.blocked")`

~~1116~~

1117 - `Optional<Object> object_`

~~1118~~

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

~~1120~~

1121 - `EVENT("event")`