API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

Create Webhook Endpoint

$ openai webhooks create

POST/webhook_endpoints

Delete Webhook Endpoint

$ openai webhooks delete

DELETE/webhook_endpoints/{webhook_endpoint_id}

List Webhook Endpoints

$ openai webhooks list

GET/webhook_endpoints

Retrieve Webhook Endpoint

$ openai webhooks retrieve

GET/webhook_endpoints/{webhook_endpoint_id}

Rotate Webhook Endpoint Signing Secret

$ openai webhooks rotate-secret

POST/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

Test Webhook Endpoint

$ openai webhooks test

POST/webhook_endpoints/{webhook_endpoint_id}/test

Update Webhook Endpoint

$ openai webhooks update

POST/webhook_endpoints/{webhook_endpoint_id}

ModelsExpand Collapse

batch_cancelled_webhook_event: object { id, created_at, data, 2 more }

Sent when a batch API request has been cancelled.

batch_completed_webhook_event: object { id, created_at, data, 2 more }

Sent when a batch API request has been completed.

batch_expired_webhook_event: object { id, created_at, data, 2 more }

Sent when a batch API request has expired.

batch_failed_webhook_event: object { id, created_at, data, 2 more }

Sent when a batch API request has failed.

deleted_webhook_endpoint: object { id, deleted, object }

eval_run_canceled_webhook_event: object { id, created_at, data, 2 more }

Sent when an eval run has been canceled.

eval_run_failed_webhook_event: object { id, created_at, data, 2 more }

Sent when an eval run has failed.

eval_run_succeeded_webhook_event: object { id, created_at, data, 2 more }

Sent when an eval run has succeeded.

fine_tuning_job_cancelled_webhook_event: object { id, created_at, data, 2 more }

Sent when a fine-tuning job has been cancelled.

fine_tuning_job_failed_webhook_event: object { id, created_at, data, 2 more }

Sent when a fine-tuning job has failed.

fine_tuning_job_succeeded_webhook_event: object { id, created_at, data, 2 more }

Sent when a fine-tuning job has succeeded.

live_call_incoming_webhook_event: object { id, created_at, data, 2 more }

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.

live_transport_incoming_webhook_event: object { id, created_at, data, 2 more }

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.

realtime_call_incoming_webhook_event: object { id, created_at, data, 2 more }

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.

response_cancelled_webhook_event: object { id, created_at, data, 2 more }

Sent when a background response has been cancelled.

response_completed_webhook_event: object { id, created_at, data, 2 more }

Sent when a background response has been completed.

response_failed_webhook_event: object { id, created_at, data, 2 more }

Sent when a background response has failed.

response_incomplete_webhook_event: object { id, created_at, data, 2 more }

Sent when a background response has been interrupted.

safety_alert_created_webhook_event: object { id, created_at, data, 2 more }

Sent when an approved safety alert is available for an API project.

safety_deactivation_issued_webhook_event: object { id, created_at, data, 2 more }

Sent when a deactivation is issued for a safety identifier in your organization.

safety_org_alert_created_webhook_event: object { id, created_at, data, 2 more }

Sent when an approved safety alert is available for an enterprise workspace.

safety_warning_issued_webhook_event: object { id, created_at, data, 2 more }

Sent when a warning is issued for a safety identifier in your organization.

webhook_endpoint: object { id, created_at, event_types, 5 more }

webhook_endpoint_list: object { data, first_id, has_more, 2 more }

webhook_endpoint_test_result: object { event_type, object, status_code, 2 more }

webhook_endpoint_with_secret: object { id, created_at, event_types, 6 more }

webhook_event_type_list: object { data, object }

WebhooksEvent Types

List Webhook Event Types

$ openai webhooks:event-types list

GET/webhook_event_types