Python 88.3%
TypeScript 7.6%
Shell 4.1%
1[2 {3 "provider": "openai",4 "event": "batch.cancelled",5 "schema_name": "WebhookBatchCancelled",6 "description": "Sent when a batch API request has been cancelled.",7 "resource_prefix": "batch_",8 "envelope": {9 "object": "event",10 "id": "evt_...",11 "created_at": "unix seconds",12 "type": "batch.cancelled",13 "data": "see data_schema"14 },15 "data_schema": {16 "id": {17 "type": "string",18 "required": true,19 "description": "The unique ID of the batch API request."20 }21 },22 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}",23 "subscribable_by_project": true,24 "in_live_event_types_list": true,25 "status": [26 "DOCUMENTED",27 "LIVE_VERIFIED"28 ],29 "source": "https://developers.openai.com/api/reference/resources/webhooks#batch.cancelled",30 "sources": [31 {32 "url": "https://developers.openai.com/api/reference/resources/webhooks",33 "retrieved_at": "2026-09-19T01:31:00Z"34 },35 {36 "url": "https://developers.openai.com/api/reference/overview",37 "retrieved_at": "2026-09-19T01:31:00Z",38 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"39 }40 ]41 },42 {43 "provider": "openai",44 "event": "batch.completed",45 "schema_name": "WebhookBatchCompleted",46 "description": "Sent when a batch API request has been completed.",47 "resource_prefix": "batch_",48 "envelope": {49 "object": "event",50 "id": "evt_...",51 "created_at": "unix seconds",52 "type": "batch.completed",53 "data": "see data_schema"54 },55 "data_schema": {56 "id": {57 "type": "string",58 "required": true,59 "description": "The unique ID of the batch API request."60 }61 },62 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.completed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}",63 "subscribable_by_project": true,64 "in_live_event_types_list": true,65 "status": [66 "DOCUMENTED",67 "LIVE_VERIFIED"68 ],69 "source": "https://developers.openai.com/api/reference/resources/webhooks#batch.completed",70 "sources": [71 {72 "url": "https://developers.openai.com/api/reference/resources/webhooks",73 "retrieved_at": "2026-09-19T01:31:00Z"74 },75 {76 "url": "https://developers.openai.com/api/reference/overview",77 "retrieved_at": "2026-09-19T01:31:00Z",78 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"79 }80 ]81 },82 {83 "provider": "openai",84 "event": "batch.expired",85 "schema_name": "WebhookBatchExpired",86 "description": "Sent when a batch API request has expired.",87 "resource_prefix": "batch_",88 "envelope": {89 "object": "event",90 "id": "evt_...",91 "created_at": "unix seconds",92 "type": "batch.expired",93 "data": "see data_schema"94 },95 "data_schema": {96 "id": {97 "type": "string",98 "required": true,99 "description": "The unique ID of the batch API request."100 }101 },102 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.expired\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}",103 "subscribable_by_project": true,104 "in_live_event_types_list": true,105 "status": [106 "DOCUMENTED",107 "LIVE_VERIFIED"108 ],109 "source": "https://developers.openai.com/api/reference/resources/webhooks#batch.expired",110 "sources": [111 {112 "url": "https://developers.openai.com/api/reference/resources/webhooks",113 "retrieved_at": "2026-09-19T01:31:00Z"114 },115 {116 "url": "https://developers.openai.com/api/reference/overview",117 "retrieved_at": "2026-09-19T01:31:00Z",118 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"119 }120 ]121 },122 {123 "provider": "openai",124 "event": "batch.failed",125 "schema_name": "WebhookBatchFailed",126 "description": "Sent when a batch API request has failed.",127 "resource_prefix": "batch_",128 "envelope": {129 "object": "event",130 "id": "evt_...",131 "created_at": "unix seconds",132 "type": "batch.failed",133 "data": "see data_schema"134 },135 "data_schema": {136 "id": {137 "type": "string",138 "required": true,139 "description": "The unique ID of the batch API request."140 }141 },142 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"batch.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"batch_abc123\"\n }\n}",143 "subscribable_by_project": true,144 "in_live_event_types_list": true,145 "status": [146 "DOCUMENTED",147 "LIVE_VERIFIED"148 ],149 "source": "https://developers.openai.com/api/reference/resources/webhooks#batch.failed",150 "sources": [151 {152 "url": "https://developers.openai.com/api/reference/resources/webhooks",153 "retrieved_at": "2026-09-19T01:31:00Z"154 },155 {156 "url": "https://developers.openai.com/api/reference/overview",157 "retrieved_at": "2026-09-19T01:31:00Z",158 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"159 }160 ]161 },162 {163 "provider": "openai",164 "event": "eval.run.canceled",165 "schema_name": "WebhookEvalRunCanceled",166 "description": "Sent when an eval run has been canceled.",167 "resource_prefix": "evalrun_",168 "envelope": {169 "object": "event",170 "id": "evt_...",171 "created_at": "unix seconds",172 "type": "eval.run.canceled",173 "data": "see data_schema"174 },175 "data_schema": {176 "id": {177 "type": "string",178 "required": true,179 "description": "The unique ID of the eval run."180 }181 },182 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.canceled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n}",183 "subscribable_by_project": true,184 "in_live_event_types_list": true,185 "status": [186 "DOCUMENTED",187 "LIVE_VERIFIED"188 ],189 "source": "https://developers.openai.com/api/reference/resources/webhooks#eval.run.canceled",190 "sources": [191 {192 "url": "https://developers.openai.com/api/reference/resources/webhooks",193 "retrieved_at": "2026-09-19T01:31:00Z"194 },195 {196 "url": "https://developers.openai.com/api/reference/overview",197 "retrieved_at": "2026-09-19T01:31:00Z",198 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"199 }200 ]201 },202 {203 "provider": "openai",204 "event": "eval.run.failed",205 "schema_name": "WebhookEvalRunFailed",206 "description": "Sent when an eval run has failed.",207 "resource_prefix": "evalrun_",208 "envelope": {209 "object": "event",210 "id": "evt_...",211 "created_at": "unix seconds",212 "type": "eval.run.failed",213 "data": "see data_schema"214 },215 "data_schema": {216 "id": {217 "type": "string",218 "required": true,219 "description": "The unique ID of the eval run."220 }221 },222 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n}",223 "subscribable_by_project": true,224 "in_live_event_types_list": true,225 "status": [226 "DOCUMENTED",227 "LIVE_VERIFIED"228 ],229 "source": "https://developers.openai.com/api/reference/resources/webhooks#eval.run.failed",230 "sources": [231 {232 "url": "https://developers.openai.com/api/reference/resources/webhooks",233 "retrieved_at": "2026-09-19T01:31:00Z"234 },235 {236 "url": "https://developers.openai.com/api/reference/overview",237 "retrieved_at": "2026-09-19T01:31:00Z",238 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"239 }240 ]241 },242 {243 "provider": "openai",244 "event": "eval.run.succeeded",245 "schema_name": "WebhookEvalRunSucceeded",246 "description": "Sent when an eval run has succeeded.",247 "resource_prefix": "evalrun_",248 "envelope": {249 "object": "event",250 "id": "evt_...",251 "created_at": "unix seconds",252 "type": "eval.run.succeeded",253 "data": "see data_schema"254 },255 "data_schema": {256 "id": {257 "type": "string",258 "required": true,259 "description": "The unique ID of the eval run."260 }261 },262 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"eval.run.succeeded\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"evalrun_abc123\"\n }\n}",263 "subscribable_by_project": true,264 "in_live_event_types_list": true,265 "status": [266 "DOCUMENTED",267 "LIVE_VERIFIED"268 ],269 "source": "https://developers.openai.com/api/reference/resources/webhooks#eval.run.succeeded",270 "sources": [271 {272 "url": "https://developers.openai.com/api/reference/resources/webhooks",273 "retrieved_at": "2026-09-19T01:31:00Z"274 },275 {276 "url": "https://developers.openai.com/api/reference/overview",277 "retrieved_at": "2026-09-19T01:31:00Z",278 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"279 }280 ]281 },282 {283 "provider": "openai",284 "event": "fine_tuning.job.cancelled",285 "schema_name": "WebhookFineTuningJobCancelled",286 "description": "Sent when a fine-tuning job has been cancelled.",287 "resource_prefix": "ftjob_",288 "envelope": {289 "object": "event",290 "id": "evt_...",291 "created_at": "unix seconds",292 "type": "fine_tuning.job.cancelled",293 "data": "see data_schema"294 },295 "data_schema": {296 "id": {297 "type": "string",298 "required": true,299 "description": "The unique ID of the fine-tuning job."300 }301 },302 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n}",303 "subscribable_by_project": true,304 "in_live_event_types_list": true,305 "status": [306 "DOCUMENTED",307 "LIVE_VERIFIED"308 ],309 "source": "https://developers.openai.com/api/reference/resources/webhooks#fine_tuning.job.cancelled",310 "sources": [311 {312 "url": "https://developers.openai.com/api/reference/resources/webhooks",313 "retrieved_at": "2026-09-19T01:31:00Z"314 },315 {316 "url": "https://developers.openai.com/api/reference/overview",317 "retrieved_at": "2026-09-19T01:31:00Z",318 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"319 }320 ]321 },322 {323 "provider": "openai",324 "event": "fine_tuning.job.failed",325 "schema_name": "WebhookFineTuningJobFailed",326 "description": "Sent when a fine-tuning job has failed.",327 "resource_prefix": "ftjob_",328 "envelope": {329 "object": "event",330 "id": "evt_...",331 "created_at": "unix seconds",332 "type": "fine_tuning.job.failed",333 "data": "see data_schema"334 },335 "data_schema": {336 "id": {337 "type": "string",338 "required": true,339 "description": "The unique ID of the fine-tuning job."340 }341 },342 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n}",343 "subscribable_by_project": true,344 "in_live_event_types_list": true,345 "status": [346 "DOCUMENTED",347 "LIVE_VERIFIED"348 ],349 "source": "https://developers.openai.com/api/reference/resources/webhooks#fine_tuning.job.failed",350 "sources": [351 {352 "url": "https://developers.openai.com/api/reference/resources/webhooks",353 "retrieved_at": "2026-09-19T01:31:00Z"354 },355 {356 "url": "https://developers.openai.com/api/reference/overview",357 "retrieved_at": "2026-09-19T01:31:00Z",358 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"359 }360 ]361 },362 {363 "provider": "openai",364 "event": "fine_tuning.job.succeeded",365 "schema_name": "WebhookFineTuningJobSucceeded",366 "description": "Sent when a fine-tuning job has succeeded.",367 "resource_prefix": "ftjob_",368 "envelope": {369 "object": "event",370 "id": "evt_...",371 "created_at": "unix seconds",372 "type": "fine_tuning.job.succeeded",373 "data": "see data_schema"374 },375 "data_schema": {376 "id": {377 "type": "string",378 "required": true,379 "description": "The unique ID of the fine-tuning job."380 }381 },382 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"fine_tuning.job.succeeded\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"ftjob_abc123\"\n }\n}",383 "subscribable_by_project": true,384 "in_live_event_types_list": true,385 "status": [386 "DOCUMENTED",387 "LIVE_VERIFIED"388 ],389 "source": "https://developers.openai.com/api/reference/resources/webhooks#fine_tuning.job.succeeded",390 "sources": [391 {392 "url": "https://developers.openai.com/api/reference/resources/webhooks",393 "retrieved_at": "2026-09-19T01:31:00Z"394 },395 {396 "url": "https://developers.openai.com/api/reference/overview",397 "retrieved_at": "2026-09-19T01:31:00Z",398 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"399 }400 ]401 },402 {403 "provider": "openai",404 "event": "live.call.incoming",405 "schema_name": "WebhookLiveCallIncoming",406 "description": "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.",407 "resource_prefix": "live_",408 "envelope": {409 "object": "event",410 "id": "evt_...",411 "created_at": "unix seconds",412 "type": "live.call.incoming",413 "data": "see data_schema"414 },415 "data_schema": {416 "session_id": {417 "type": "string",418 "required": true,419 "description": "The `live_...` ID of the pending SIP session. Pass this value unchanged to Live call controls and sideband connections. The corresponding `realtime.call.incoming` event uses a separate `rtc_...` call ID."420 },421 "sip_media_security": {422 "type": "string",423 "required": false,424 "description": "Media protection selected on the SIP leg during SDP negotiation. `srtp` indicates SRTP; `rtp` indicates 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.",425 "enum": [426 "rtp",427 "srtp"428 ]429 },430 "sip_headers": {431 "type": "array<object>",432 "required": true,433 "description": "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.",434 "properties": {435 "name": "string",436 "value": "string"437 }438 }439 },440 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"live.call.incoming\",\n \"created_at\": 1719168000,\n \"data\": {\n \"session_id\": \"live_u0_479a275623b54bdb9b6fbae2f7cbd408\",\n \"sip_media_security\": \"srtp\",\n \"sip_headers\": [\n {\"name\": \"From\", \"value\": \"<sip:alice@example.com>;tag=abc123\"},\n {\"name\": \"To\", \"value\": \"<sip:recipient@example.com>\"},\n {\"name\": \"Call-ID\", \"value\": \"call-123@example.com\"}\n ]\n }\n}",441 "subscribable_by_project": false,442 "in_live_event_types_list": false,443 "status": [444 "DOCUMENTED",445 "DEPRECATED"446 ],447 "source": "https://developers.openai.com/api/reference/resources/webhooks#live.call.incoming",448 "sources": [449 {450 "url": "https://developers.openai.com/api/reference/resources/webhooks",451 "retrieved_at": "2026-09-19T01:31:00Z"452 },453 {454 "url": "https://developers.openai.com/api/reference/overview",455 "retrieved_at": "2026-09-19T01:31:00Z",456 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"457 }458 ]459 },460 {461 "provider": "openai",462 "event": "live.transport.incoming",463 "schema_name": "WebhookLiveTransportIncoming",464 "description": "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.",465 "resource_prefix": "live_",466 "envelope": {467 "object": "event",468 "id": "evt_...",469 "created_at": "unix seconds",470 "type": "live.transport.incoming",471 "data": "see data_schema"472 },473 "data_schema": {474 "type": {475 "type": "string",476 "required": true,477 "description": "The incoming transport type. Always `sip`.",478 "enum": [479 "sip"480 ]481 },482 "session_id": {483 "type": "string",484 "required": true,485 "description": "The `live_...` ID of the pending SIP session. Forward this value unchanged when accepting or rejecting the call through the Live API."486 },487 "sip_media_security": {488 "type": "string",489 "required": false,490 "description": "Media protection selected on the SIP leg during SDP negotiation. `srtp` indicates SRTP; `rtp` indicates 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.",491 "enum": [492 "rtp",493 "srtp"494 ]495 },496 "sip_headers": {497 "type": "array<object>",498 "required": true,499 "description": "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.",500 "properties": {501 "name": "string",502 "value": "string"503 }504 }505 },506 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"live.transport.incoming\",\n \"created_at\": 1719168000,\n \"data\": {\n \"type\": \"sip\",\n \"session_id\": \"live_u0_479a275623b54bdb9b6fbae2f7cbd408\",\n \"sip_media_security\": \"srtp\",\n \"sip_headers\": [\n {\"name\": \"From\", \"value\": \"<sip:alice@example.com>;tag=abc123\"},\n {\"name\": \"To\", \"value\": \"<sip:recipient@example.com>\"},\n {\"name\": \"Call-ID\", \"value\": \"call-123@example.com\"}\n ]\n }\n}",507 "subscribable_by_project": true,508 "in_live_event_types_list": true,509 "status": [510 "DOCUMENTED",511 "LIVE_VERIFIED"512 ],513 "source": "https://developers.openai.com/api/reference/resources/webhooks#live.transport.incoming",514 "sources": [515 {516 "url": "https://developers.openai.com/api/reference/resources/webhooks",517 "retrieved_at": "2026-09-19T01:31:00Z"518 },519 {520 "url": "https://developers.openai.com/api/reference/overview",521 "retrieved_at": "2026-09-19T01:31:00Z",522 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"523 }524 ]525 },526 {527 "provider": "openai",528 "event": "realtime.call.incoming",529 "schema_name": "WebhookRealtimeCallIncoming",530 "description": "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.",531 "resource_prefix": "rtc_",532 "envelope": {533 "object": "event",534 "id": "evt_...",535 "created_at": "unix seconds",536 "type": "realtime.call.incoming",537 "data": "see data_schema"538 },539 "data_schema": {540 "call_id": {541 "type": "string",542 "required": true,543 "description": "The 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_id` from `live.transport.incoming` instead."544 },545 "sip_media_security": {546 "type": "string",547 "required": false,548 "description": "Media protection selected on the SIP leg during SDP negotiation. `srtp` indicates SRTP; `rtp` indicates 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.",549 "enum": [550 "rtp",551 "srtp"552 ]553 },554 "sip_headers": {555 "type": "array<object>",556 "required": true,557 "description": "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.",558 "properties": {559 "name": "string",560 "value": "string"561 }562 }563 },564 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"realtime.call.incoming\",\n \"created_at\": 1719168000,\n \"data\": {\n \"call_id\": \"rtc_u0_479a275623b54bdb9b6fbae2f7cbd408\",\n \"sip_media_security\": \"srtp\",\n \"sip_headers\": [\n {\"name\": \"Max-Forwards\", \"value\": \"63\"},\n {\"name\": \"CSeq\", \"value\": \"851287 INVITE\"},\n {\"name\": \"Content-Type\", \"value\": \"application/sdp\"}\n ]\n }\n}",565 "subscribable_by_project": true,566 "in_live_event_types_list": true,567 "status": [568 "DOCUMENTED",569 "LIVE_VERIFIED"570 ],571 "source": "https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming",572 "sources": [573 {574 "url": "https://developers.openai.com/api/reference/resources/webhooks",575 "retrieved_at": "2026-09-19T01:31:00Z"576 },577 {578 "url": "https://developers.openai.com/api/reference/overview",579 "retrieved_at": "2026-09-19T01:31:00Z",580 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"581 }582 ]583 },584 {585 "provider": "openai",586 "event": "response.cancelled",587 "schema_name": "WebhookResponseCancelled",588 "description": "Sent when a background response has been cancelled.",589 "resource_prefix": "resp_",590 "envelope": {591 "object": "event",592 "id": "evt_...",593 "created_at": "unix seconds",594 "type": "response.cancelled",595 "data": "see data_schema"596 },597 "data_schema": {598 "id": {599 "type": "string",600 "required": true,601 "description": "The unique ID of the model response."602 }603 },604 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"response.cancelled\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}",605 "subscribable_by_project": true,606 "in_live_event_types_list": true,607 "status": [608 "DOCUMENTED",609 "LIVE_VERIFIED"610 ],611 "source": "https://developers.openai.com/api/reference/resources/webhooks#response.cancelled",612 "sources": [613 {614 "url": "https://developers.openai.com/api/reference/resources/webhooks",615 "retrieved_at": "2026-09-19T01:31:00Z"616 },617 {618 "url": "https://developers.openai.com/api/reference/overview",619 "retrieved_at": "2026-09-19T01:31:00Z",620 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"621 }622 ]623 },624 {625 "provider": "openai",626 "event": "response.completed",627 "schema_name": "WebhookResponseCompleted",628 "description": "Sent when a background response has been completed.",629 "resource_prefix": "resp_",630 "envelope": {631 "object": "event",632 "id": "evt_...",633 "created_at": "unix seconds",634 "type": "response.completed",635 "data": "see data_schema"636 },637 "data_schema": {638 "id": {639 "type": "string",640 "required": true,641 "description": "The unique ID of the model response."642 }643 },644 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"response.completed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}",645 "subscribable_by_project": true,646 "in_live_event_types_list": true,647 "status": [648 "DOCUMENTED",649 "LIVE_VERIFIED"650 ],651 "source": "https://developers.openai.com/api/reference/resources/webhooks#response.completed",652 "sources": [653 {654 "url": "https://developers.openai.com/api/reference/resources/webhooks",655 "retrieved_at": "2026-09-19T01:31:00Z"656 },657 {658 "url": "https://developers.openai.com/api/reference/overview",659 "retrieved_at": "2026-09-19T01:31:00Z",660 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"661 }662 ]663 },664 {665 "provider": "openai",666 "event": "response.failed",667 "schema_name": "WebhookResponseFailed",668 "description": "Sent when a background response has failed.",669 "resource_prefix": "resp_",670 "envelope": {671 "object": "event",672 "id": "evt_...",673 "created_at": "unix seconds",674 "type": "response.failed",675 "data": "see data_schema"676 },677 "data_schema": {678 "id": {679 "type": "string",680 "required": true,681 "description": "The unique ID of the model response."682 }683 },684 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"response.failed\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}",685 "subscribable_by_project": true,686 "in_live_event_types_list": true,687 "status": [688 "DOCUMENTED",689 "LIVE_VERIFIED"690 ],691 "source": "https://developers.openai.com/api/reference/resources/webhooks#response.failed",692 "sources": [693 {694 "url": "https://developers.openai.com/api/reference/resources/webhooks",695 "retrieved_at": "2026-09-19T01:31:00Z"696 },697 {698 "url": "https://developers.openai.com/api/reference/overview",699 "retrieved_at": "2026-09-19T01:31:00Z",700 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"701 }702 ]703 },704 {705 "provider": "openai",706 "event": "response.incomplete",707 "schema_name": "WebhookResponseIncomplete",708 "description": "Sent when a background response has been interrupted.",709 "resource_prefix": "resp_",710 "envelope": {711 "object": "event",712 "id": "evt_...",713 "created_at": "unix seconds",714 "type": "response.incomplete",715 "data": "see data_schema"716 },717 "data_schema": {718 "id": {719 "type": "string",720 "required": true,721 "description": "The unique ID of the model response."722 }723 },724 "example": "{\n \"id\": \"evt_abc123\",\n \"type\": \"response.incomplete\",\n \"created_at\": 1719168000,\n \"data\": {\n \"id\": \"resp_abc123\"\n }\n}",725 "subscribable_by_project": true,726 "in_live_event_types_list": true,727 "status": [728 "DOCUMENTED",729 "LIVE_VERIFIED"730 ],731 "source": "https://developers.openai.com/api/reference/resources/webhooks#response.incomplete",732 "sources": [733 {734 "url": "https://developers.openai.com/api/reference/resources/webhooks",735 "retrieved_at": "2026-09-19T01:31:00Z"736 },737 {738 "url": "https://developers.openai.com/api/reference/overview",739 "retrieved_at": "2026-09-19T01:31:00Z",740 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"741 }742 ]743 },744 {745 "provider": "openai",746 "event": "safety.alert.created",747 "schema_name": "WebhookSafetyAlertCreated",748 "description": "Sent when an approved safety alert is available for an API project.",749 "resource_prefix": "C-/alert_",750 "envelope": {751 "object": "event",752 "id": "evt_...",753 "created_at": "unix seconds",754 "type": "safety.alert.created",755 "data": "see data_schema"756 },757 "data_schema": {758 "id": {759 "type": "string",760 "required": true,761 "description": "The safety alert ID to pass to `GET /v1/safety/alerts/{id}`."762 }763 },764 "example": "{\n \"id\": \"evt_123\",\n \"object\": \"event\",\n \"created_at\": 1787659200,\n \"type\": \"safety.alert.created\",\n \"data\": {\"id\": \"alert_0123456789abcdef0123456789abcdef\"}\n}",765 "subscribable_by_project": true,766 "in_live_event_types_list": true,767 "status": [768 "DOCUMENTED",769 "LIVE_VERIFIED"770 ],771 "source": "https://developers.openai.com/api/reference/resources/webhooks#safety.alert.created",772 "sources": [773 {774 "url": "https://developers.openai.com/api/reference/resources/webhooks",775 "retrieved_at": "2026-09-19T01:31:00Z"776 },777 {778 "url": "https://developers.openai.com/api/reference/overview",779 "retrieved_at": "2026-09-19T01:31:00Z",780 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"781 }782 ]783 },784 {785 "provider": "openai",786 "event": "safety.deactivation_issued",787 "schema_name": "WebhookSafetyDeactivationIssued",788 "description": "Sent when a deactivation is issued for a safety identifier in your organization.",789 "resource_prefix": "C-/alert_",790 "envelope": {791 "object": "event",792 "id": "evt_...",793 "created_at": "unix seconds",794 "type": "safety.deactivation_issued",795 "data": "see data_schema"796 },797 "data_schema": {798 "id": {799 "type": "string",800 "required": true,801 "description": "The safety case ID to pass to `GET /v1/safety/cases/{id}`."802 }803 },804 "example": "{\n \"id\": \"evt_123\",\n \"object\": \"event\",\n \"created_at\": 1787659200,\n \"type\": \"safety.deactivation_issued\",\n \"data\": {\"id\": \"C-abc123\"}\n}",805 "subscribable_by_project": false,806 "in_live_event_types_list": false,807 "status": [808 "DOCUMENTED"809 ],810 "source": "https://developers.openai.com/api/reference/resources/webhooks#safety.deactivation_issued",811 "sources": [812 {813 "url": "https://developers.openai.com/api/reference/resources/webhooks",814 "retrieved_at": "2026-09-19T01:31:00Z"815 },816 {817 "url": "https://developers.openai.com/api/reference/overview",818 "retrieved_at": "2026-09-19T01:31:00Z",819 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"820 }821 ]822 },823 {824 "provider": "openai",825 "event": "safety.org_alert.created",826 "schema_name": "WebhookSafetyOrgAlertCreated",827 "description": "Sent when an approved safety alert is available for an enterprise workspace.",828 "resource_prefix": "C-/alert_",829 "envelope": {830 "object": "event",831 "id": "evt_...",832 "created_at": "unix seconds",833 "type": "safety.org_alert.created",834 "data": "see data_schema"835 },836 "data_schema": {837 "id": {838 "type": "string",839 "required": true,840 "description": "The safety alert ID to pass to `GET /v1/safety/alerts/{id}`."841 }842 },843 "example": "{\n \"id\": \"evt_123\",\n \"object\": \"event\",\n \"created_at\": 1787659200,\n \"type\": \"safety.org_alert.created\",\n \"data\": {\"id\": \"alert_0123456789abcdef0123456789abcdef\"}\n}",844 "subscribable_by_project": false,845 "in_live_event_types_list": false,846 "status": [847 "DOCUMENTED"848 ],849 "source": "https://developers.openai.com/api/reference/resources/webhooks#safety.org_alert.created",850 "sources": [851 {852 "url": "https://developers.openai.com/api/reference/resources/webhooks",853 "retrieved_at": "2026-09-19T01:31:00Z"854 },855 {856 "url": "https://developers.openai.com/api/reference/overview",857 "retrieved_at": "2026-09-19T01:31:00Z",858 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"859 }860 ]861 },862 {863 "provider": "openai",864 "event": "safety.warning_issued",865 "schema_name": "WebhookSafetyWarningIssued",866 "description": "Sent when a warning is issued for a safety identifier in your organization.",867 "resource_prefix": "C-/alert_",868 "envelope": {869 "object": "event",870 "id": "evt_...",871 "created_at": "unix seconds",872 "type": "safety.warning_issued",873 "data": "see data_schema"874 },875 "data_schema": {876 "id": {877 "type": "string",878 "required": true,879 "description": "The safety case ID to pass to `GET /v1/safety/cases/{id}`."880 }881 },882 "example": "{\n \"id\": \"evt_123\",\n \"object\": \"event\",\n \"created_at\": 1787659200,\n \"type\": \"safety.warning_issued\",\n \"data\": {\"id\": \"C-abc123\"}\n}",883 "subscribable_by_project": false,884 "in_live_event_types_list": false,885 "status": [886 "DOCUMENTED"887 ],888 "source": "https://developers.openai.com/api/reference/resources/webhooks#safety.warning_issued",889 "sources": [890 {891 "url": "https://developers.openai.com/api/reference/resources/webhooks",892 "retrieved_at": "2026-09-19T01:31:00Z"893 },894 {895 "url": "https://developers.openai.com/api/reference/overview",896 "retrieved_at": "2026-09-19T01:31:00Z",897 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"898 }899 ]900 },901 {902 "provider": "openai",903 "event": "video.completed",904 "schema_name": null,905 "description": "Sent when a video generation job completes. data.id = video job id (video_...).",906 "resource_prefix": "video_",907 "envelope": {908 "object": "event",909 "id": "evt_...",910 "created_at": "unix seconds",911 "type": "video.completed",912 "data": {913 "id": "resource id"914 }915 },916 "data_schema": {917 "id": {918 "type": "string",919 "required": true,920 "description": "ID of the resource that triggered the event."921 }922 },923 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"video.completed\", \"data\": {\"id\": \"video_abc123\"}}",924 "subscribable_by_project": true,925 "in_live_event_types_list": true,926 "status": [927 "DOCUMENTED",928 "LIVE_VERIFIED"929 ],930 "source": "https://developers.openai.com/api/docs/guides/video-generation#use-webhooks-for-notifications",931 "sources": [932 {933 "url": "https://developers.openai.com/api/docs/guides/video-generation#use-webhooks-for-notifications",934 "retrieved_at": "2026-09-19T01:31:00Z"935 },936 {937 "url": "https://developers.openai.com/api/reference/overview",938 "retrieved_at": "2026-09-19T01:31:00Z",939 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"940 }941 ]942 },943 {944 "provider": "openai",945 "event": "video.failed",946 "schema_name": null,947 "description": "Sent when a video generation job fails. data.id = video job id (video_...).",948 "resource_prefix": "video_",949 "envelope": {950 "object": "event",951 "id": "evt_...",952 "created_at": "unix seconds",953 "type": "video.failed",954 "data": {955 "id": "resource id"956 }957 },958 "data_schema": {959 "id": {960 "type": "string",961 "required": true,962 "description": "ID of the resource that triggered the event."963 }964 },965 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"video.failed\", \"data\": {\"id\": \"video_abc123\"}}",966 "subscribable_by_project": true,967 "in_live_event_types_list": true,968 "status": [969 "DOCUMENTED",970 "LIVE_VERIFIED"971 ],972 "source": "https://developers.openai.com/api/docs/guides/video-generation#use-webhooks-for-notifications",973 "sources": [974 {975 "url": "https://developers.openai.com/api/docs/guides/video-generation#use-webhooks-for-notifications",976 "retrieved_at": "2026-09-19T01:31:00Z"977 },978 {979 "url": "https://developers.openai.com/api/reference/overview",980 "retrieved_at": "2026-09-19T01:31:00Z",981 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"982 }983 ]984 },985 {986 "provider": "openai",987 "event": "agent.session.created",988 "schema_name": null,989 "description": "Agents API: a session is created. data: id (sess_...), environment_id, environment_type, connect.remote_url (self-hosted sessions).",990 "resource_prefix": "sess_",991 "envelope": {992 "object": "event",993 "id": "evt_...",994 "created_at": "unix seconds",995 "type": "agent.session.created",996 "data": {997 "id": "resource id"998 }999 },1000 "data_schema": {1001 "id": {1002 "type": "string",1003 "required": true,1004 "description": "ID of the resource that triggered the event."1005 }1006 },1007 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"agent.session.created\", \"data\": {\"id\": \"sess_abc123\"}}",1008 "subscribable_by_project": true,1009 "in_live_event_types_list": true,1010 "status": [1011 "DOCUMENTED",1012 "LIVE_DISCOVERED",1013 "BETA"1014 ],1015 "source": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1016 "sources": [1017 {1018 "url": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1019 "retrieved_at": "2026-09-19T01:31:00Z"1020 },1021 {1022 "url": "https://developers.openai.com/api/reference/overview",1023 "retrieved_at": "2026-09-19T01:31:00Z",1024 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"1025 }1026 ]1027 },1028 {1029 "provider": "openai",1030 "event": "agent.session.action_required",1031 "schema_name": null,1032 "description": "Agents API: the session needs a function result, initial environment connection, or reconnection. data: id, required_action.type = function_call | environment_connection.",1033 "resource_prefix": "sess_",1034 "envelope": {1035 "object": "event",1036 "id": "evt_...",1037 "created_at": "unix seconds",1038 "type": "agent.session.action_required",1039 "data": {1040 "id": "resource id"1041 }1042 },1043 "data_schema": {1044 "id": {1045 "type": "string",1046 "required": true,1047 "description": "ID of the resource that triggered the event."1048 }1049 },1050 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"agent.session.action_required\", \"data\": {\"id\": \"sess_abc123\"}}",1051 "subscribable_by_project": true,1052 "in_live_event_types_list": true,1053 "status": [1054 "DOCUMENTED",1055 "LIVE_DISCOVERED",1056 "BETA"1057 ],1058 "source": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1059 "sources": [1060 {1061 "url": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1062 "retrieved_at": "2026-09-19T01:31:00Z"1063 },1064 {1065 "url": "https://developers.openai.com/api/reference/overview",1066 "retrieved_at": "2026-09-19T01:31:00Z",1067 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"1068 }1069 ]1070 },1071 {1072 "provider": "openai",1073 "event": "agent.session.in_progress",1074 "schema_name": null,1075 "description": "Agents API: the session starts processing a turn. data.id = session id.",1076 "resource_prefix": "sess_",1077 "envelope": {1078 "object": "event",1079 "id": "evt_...",1080 "created_at": "unix seconds",1081 "type": "agent.session.in_progress",1082 "data": {1083 "id": "resource id"1084 }1085 },1086 "data_schema": {1087 "id": {1088 "type": "string",1089 "required": true,1090 "description": "ID of the resource that triggered the event."1091 }1092 },1093 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"agent.session.in_progress\", \"data\": {\"id\": \"sess_abc123\"}}",1094 "subscribable_by_project": true,1095 "in_live_event_types_list": true,1096 "status": [1097 "DOCUMENTED",1098 "LIVE_DISCOVERED",1099 "BETA"1100 ],1101 "source": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1102 "sources": [1103 {1104 "url": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1105 "retrieved_at": "2026-09-19T01:31:00Z"1106 },1107 {1108 "url": "https://developers.openai.com/api/reference/overview",1109 "retrieved_at": "2026-09-19T01:31:00Z",1110 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"1111 }1112 ]1113 },1114 {1115 "provider": "openai",1116 "event": "agent.session.idle",1117 "schema_name": null,1118 "description": "Agents API: the session is idle and ready for more input. data.id = session id.",1119 "resource_prefix": "sess_",1120 "envelope": {1121 "object": "event",1122 "id": "evt_...",1123 "created_at": "unix seconds",1124 "type": "agent.session.idle",1125 "data": {1126 "id": "resource id"1127 }1128 },1129 "data_schema": {1130 "id": {1131 "type": "string",1132 "required": true,1133 "description": "ID of the resource that triggered the event."1134 }1135 },1136 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"agent.session.idle\", \"data\": {\"id\": \"sess_abc123\"}}",1137 "subscribable_by_project": true,1138 "in_live_event_types_list": true,1139 "status": [1140 "DOCUMENTED",1141 "LIVE_DISCOVERED",1142 "BETA"1143 ],1144 "source": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1145 "sources": [1146 {1147 "url": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1148 "retrieved_at": "2026-09-19T01:31:00Z"1149 },1150 {1151 "url": "https://developers.openai.com/api/reference/overview",1152 "retrieved_at": "2026-09-19T01:31:00Z",1153 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"1154 }1155 ]1156 },1157 {1158 "provider": "openai",1159 "event": "agent.session.failed",1160 "schema_name": null,1161 "description": "Agents API: the session enters a failed state. data.id = session id.",1162 "resource_prefix": "sess_",1163 "envelope": {1164 "object": "event",1165 "id": "evt_...",1166 "created_at": "unix seconds",1167 "type": "agent.session.failed",1168 "data": {1169 "id": "resource id"1170 }1171 },1172 "data_schema": {1173 "id": {1174 "type": "string",1175 "required": true,1176 "description": "ID of the resource that triggered the event."1177 }1178 },1179 "example": "{\"id\": \"evt_abc123\", \"object\": \"event\", \"created_at\": 1758941485, \"type\": \"agent.session.failed\", \"data\": {\"id\": \"sess_abc123\"}}",1180 "subscribable_by_project": true,1181 "in_live_event_types_list": true,1182 "status": [1183 "DOCUMENTED",1184 "LIVE_DISCOVERED",1185 "BETA"1186 ],1187 "source": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1188 "sources": [1189 {1190 "url": "https://developers.openai.com/api/docs/guides/agents-api/sessions/webhooks",1191 "retrieved_at": "2026-09-19T01:31:00Z"1192 },1193 {1194 "url": "https://developers.openai.com/api/reference/overview",1195 "retrieved_at": "2026-09-19T01:31:00Z",1196 "note": "OpenAPI spec openapi-master.yaml v2.3.0 (sources/openai/openapi/openapi-master.yaml)"1197 }1198 ]1199 }1200]1201