Webhooks events
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending
.mdto the page URL.
Webhooks are HTTP requests sent by OpenAI to a URL you specify when certain events happen during the course of API usage.
response.completed
Sent when a background response has been completed.
Schema
Schema name: WebhookResponseCompleted
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the model response was completed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the model response.
-
-
type: "response.completed"The type of the event. Always
response.completed."response.completed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "response.completed",
"created_at": 1719168000,
"data": {
"id": "resp_abc123"
}
}response.cancelled
Sent when a background response has been cancelled.
Schema
Schema name: WebhookResponseCancelled
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the model response was cancelled.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the model response.
-
-
type: "response.cancelled"The type of the event. Always
response.cancelled."response.cancelled"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "response.cancelled",
"created_at": 1719168000,
"data": {
"id": "resp_abc123"
}
}response.failed
Sent when a background response has failed.
Schema
Schema name: WebhookResponseFailed
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the model response failed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the model response.
-
-
type: "response.failed"The type of the event. Always
response.failed."response.failed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "response.failed",
"created_at": 1719168000,
"data": {
"id": "resp_abc123"
}
}response.incomplete
Sent when a background response has been interrupted.
Schema
Schema name: WebhookResponseIncomplete
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the model response was interrupted.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the model response.
-
-
type: "response.incomplete"The type of the event. Always
response.incomplete."response.incomplete"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "response.incomplete",
"created_at": 1719168000,
"data": {
"id": "resp_abc123"
}
}batch.completed
Sent when a batch API request has been completed.
Schema
Schema name: WebhookBatchCompleted
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the batch API request was completed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the batch API request.
-
-
type: "batch.completed"The type of the event. Always
batch.completed."batch.completed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "batch.completed",
"created_at": 1719168000,
"data": {
"id": "batch_abc123"
}
}batch.cancelled
Sent when a batch API request has been cancelled.
Schema
Schema name: WebhookBatchCancelled
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the batch API request was cancelled.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the batch API request.
-
-
type: "batch.cancelled"The type of the event. Always
batch.cancelled."batch.cancelled"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "batch.cancelled",
"created_at": 1719168000,
"data": {
"id": "batch_abc123"
}
}batch.expired
Sent when a batch API request has expired.
Schema
Schema name: WebhookBatchExpired
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the batch API request expired.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the batch API request.
-
-
type: "batch.expired"The type of the event. Always
batch.expired."batch.expired"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "batch.expired",
"created_at": 1719168000,
"data": {
"id": "batch_abc123"
}
}batch.failed
Sent when a batch API request has failed.
Schema
Schema name: WebhookBatchFailed
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the batch API request failed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the batch API request.
-
-
type: "batch.failed"The type of the event. Always
batch.failed."batch.failed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "batch.failed",
"created_at": 1719168000,
"data": {
"id": "batch_abc123"
}
}fine_tuning.job.succeeded
Sent when a fine-tuning job has succeeded.
Schema
Schema name: WebhookFineTuningJobSucceeded
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the fine-tuning job succeeded.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the fine-tuning job.
-
-
type: "fine_tuning.job.succeeded"The type of the event. Always
fine_tuning.job.succeeded."fine_tuning.job.succeeded"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "fine_tuning.job.succeeded",
"created_at": 1719168000,
"data": {
"id": "ftjob_abc123"
}
}fine_tuning.job.failed
Sent when a fine-tuning job has failed.
Schema
Schema name: WebhookFineTuningJobFailed
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the fine-tuning job failed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the fine-tuning job.
-
-
type: "fine_tuning.job.failed"The type of the event. Always
fine_tuning.job.failed."fine_tuning.job.failed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "fine_tuning.job.failed",
"created_at": 1719168000,
"data": {
"id": "ftjob_abc123"
}
}fine_tuning.job.cancelled
Sent when a fine-tuning job has been cancelled.
Schema
Schema name: WebhookFineTuningJobCancelled
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the fine-tuning job.
-
-
type: "fine_tuning.job.cancelled"The type of the event. Always
fine_tuning.job.cancelled."fine_tuning.job.cancelled"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "fine_tuning.job.cancelled",
"created_at": 1719168000,
"data": {
"id": "ftjob_abc123"
}
}eval.run.succeeded
Sent when an eval run has succeeded.
Schema
Schema name: WebhookEvalRunSucceeded
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the eval run succeeded.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the eval run.
-
-
type: "eval.run.succeeded"The type of the event. Always
eval.run.succeeded."eval.run.succeeded"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "eval.run.succeeded",
"created_at": 1719168000,
"data": {
"id": "evalrun_abc123"
}
}eval.run.failed
Sent when an eval run has failed.
Schema
Schema name: WebhookEvalRunFailed
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the eval run failed.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the eval run.
-
-
type: "eval.run.failed"The type of the event. Always
eval.run.failed."eval.run.failed"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "eval.run.failed",
"created_at": 1719168000,
"data": {
"id": "evalrun_abc123"
}
}eval.run.canceled
Sent when an eval run has been canceled.
Schema
Schema name: WebhookEvalRunCanceled
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the eval run was canceled.
-
data: object { id }Event data payload.
-
id: stringThe unique ID of the eval run.
-
-
type: "eval.run.canceled"The type of the event. Always
eval.run.canceled."eval.run.canceled"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "eval.run.canceled",
"created_at": 1719168000,
"data": {
"id": "evalrun_abc123"
}
}realtime.call.incoming
Sent when an incoming API SIP session is available for Realtime acceptance.
The same pending session can also emit live.transport.incoming; the first
successful Realtime or Live accept endpoint selects the runtime surface.
Schema
Schema name: WebhookRealtimeCallIncoming
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the model response was completed.
-
data: object { call_id, sip_headers, sip_media_security }Event data payload.
-
call_id: stringThe ID of the pending SIP call. Pass this value unchanged when accepting or rejecting the call through the Realtime API. For the Live API, use the
session_idfromlive.transport.incominginstead. -
sip_headers: array of object { name, value }Headers from the SIP INVITE, excluding SIP authorization headers. Retained names, values, repeated entries, and order are preserved. Treat these values as untrusted call metadata.
-
name: stringName of the SIP Header.
-
value: stringValue of the SIP Header.
-
-
sip_media_security: optional "rtp" or "srtp" or stringMedia protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" or "srtp"Media protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" -
"srtp"
-
-
string
-
-
-
type: "realtime.call.incoming"The type of the event. Always
realtime.call.incoming."realtime.call.incoming"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "realtime.call.incoming",
"created_at": 1719168000,
"data": {
"call_id": "rtc_u0_479a275623b54bdb9b6fbae2f7cbd408",
"sip_media_security": "srtp",
"sip_headers": [
{"name": "Max-Forwards", "value": "63"},
{"name": "CSeq", "value": "851287 INVITE"},
{"name": "Content-Type", "value": "application/sdp"}
]
}
}live.call.incoming
Deprecated: use live.transport.incoming. Retained for existing subscriptions
during migration; new subscriptions to this event are not allowed.
Sent when an incoming API SIP session is available for Live acceptance. The
same pending session can also emit realtime.call.incoming; the first
successful Realtime or Live accept endpoint selects the runtime surface.
Schema
Schema name: WebhookLiveCallIncoming
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the event was created.
-
data: object { session_id, sip_headers, sip_media_security }Event data payload.
-
session_id: stringThe
live_...ID of the pending SIP session. Pass this value unchanged to Live call controls and sideband connections. The correspondingrealtime.call.incomingevent uses a separatertc_...call ID. -
sip_headers: array of object { name, value }Headers from the SIP INVITE, excluding SIP authorization headers. Retained names, values, repeated entries, and order are preserved. Treat these values as untrusted call metadata.
-
name: stringName of the SIP Header.
-
value: stringValue of the SIP Header.
-
-
sip_media_security: optional "rtp" or "srtp" or stringMedia protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" or "srtp"Media protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" -
"srtp"
-
-
string
-
-
-
type: "live.call.incoming"The type of the event. Always
live.call.incoming."live.call.incoming"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "live.call.incoming",
"created_at": 1719168000,
"data": {
"session_id": "live_u0_479a275623b54bdb9b6fbae2f7cbd408",
"sip_media_security": "srtp",
"sip_headers": [
{"name": "From", "value": "<sip:alice@example.com>;tag=abc123"},
{"name": "To", "value": "<sip:recipient@example.com>"},
{"name": "Call-ID", "value": "call-123@example.com"}
]
}
}live.transport.incoming
Sent when an incoming API SIP session is available for Live acceptance. The
same pending session can also emit realtime.call.incoming; the first
successful Realtime or Live accept endpoint selects the runtime surface.
Schema
Schema name: WebhookLiveTransportIncoming
-
id: stringThe unique ID of the event.
-
created_at: numberThe Unix timestamp (in seconds) of when the event was created.
-
data: object { session_id, sip_headers, type, sip_media_security }Event data payload.
-
session_id: stringThe
live_...ID of the pending SIP session. Forward this value unchanged when accepting or rejecting the call through the Live API. -
sip_headers: array of object { name, value }Headers from the SIP INVITE, excluding SIP authorization headers. Retained names, values, repeated entries, and order are preserved. Treat these values as untrusted call metadata.
-
name: stringName of the SIP Header.
-
value: stringValue of the SIP Header.
-
-
type: "sip"The incoming transport type. Always
sip."sip"
-
sip_media_security: optional "rtp" or "srtp" or stringMedia protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" or "srtp"Media protection selected on the SIP leg during SDP negotiation.
srtpindicates SRTP;rtpindicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.-
"rtp" -
"srtp"
-
-
string
-
-
-
type: "live.transport.incoming"The type of the event. Always
live.transport.incoming."live.transport.incoming"
-
object: optional "event"The object of the event. Always
event."event"
Example
{
"id": "evt_abc123",
"type": "live.transport.incoming",
"created_at": 1719168000,
"data": {
"type": "sip",
"session_id": "live_u0_479a275623b54bdb9b6fbae2f7cbd408",
"sip_media_security": "srtp",
"sip_headers": [
{"name": "From", "value": "<sip:alice@example.com>;tag=abc123"},
{"name": "To", "value": "<sip:recipient@example.com>"},
{"name": "Call-ID", "value": "call-123@example.com"}
]
}
}safety.warning_issued
Sent when a warning is issued for a safety identifier in your organization.
Schema
Schema name: WebhookSafetyWarningIssued
-
id: stringThe unique ID of the webhook event.
-
created_at: numberThe Unix timestamp in seconds when the event was created.
-
data: object { id }-
id: stringThe safety case ID to pass to
GET /v1/safety/cases/{id}.
-
-
object: "event"Always
event."event"
-
type: "safety.warning_issued"Always
safety.warning_issued."safety.warning_issued"
Example
{
"id": "evt_123",
"object": "event",
"created_at": 1787659200,
"type": "safety.warning_issued",
"data": {"id": "C-abc123"}
}safety.deactivation_issued
Sent when a deactivation is issued for a safety identifier in your organization.
Schema
Schema name: WebhookSafetyDeactivationIssued
-
id: stringThe unique ID of the webhook event.
-
created_at: numberThe Unix timestamp in seconds when the event was created.
-
data: object { id }-
id: stringThe safety case ID to pass to
GET /v1/safety/cases/{id}.
-
-
object: "event"Always
event."event"
-
type: "safety.deactivation_issued"Always
safety.deactivation_issued."safety.deactivation_issued"
Example
{
"id": "evt_123",
"object": "event",
"created_at": 1787659200,
"type": "safety.deactivation_issued",
"data": {"id": "C-abc123"}
}safety.alert.created
Sent when an approved safety alert is available for an API project.
Schema
Schema name: WebhookSafetyAlertCreated
-
id: stringThe unique ID of the webhook event.
-
created_at: numberThe Unix timestamp in seconds when the event was created.
-
data: object { id }-
id: stringThe safety alert ID to pass to
GET /v1/safety/alerts/{id}.
-
-
object: "event"Always
event."event"
-
type: "safety.alert.created"Always
safety.alert.created."safety.alert.created"
Example
{
"id": "evt_123",
"object": "event",
"created_at": 1787659200,
"type": "safety.alert.created",
"data": {"id": "alert_0123456789abcdef0123456789abcdef"}
}safety.org_alert.created
Sent when an approved safety alert is available for an enterprise workspace.
Schema
Schema name: WebhookSafetyOrgAlertCreated
-
id: stringThe unique ID of the webhook event.
-
created_at: numberThe Unix timestamp in seconds when the event was created.
-
data: object { id }-
id: stringThe safety alert ID to pass to
GET /v1/safety/alerts/{id}.
-
-
object: "event"Always
event."event"
-
type: "safety.org_alert.created"Always
safety.org_alert.created."safety.org_alert.created"
Example
{
"id": "evt_123",
"object": "event",
"created_at": 1787659200,
"type": "safety.org_alert.created",
"data": {"id": "alert_0123456789abcdef0123456789abcdef"}
}