API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Webhook Endpoint

$ openai webhooks create

POST/webhook_endpoints

Creates a webhook endpoint for the authenticated project.

ParametersExpand Collapse

--event-type: array of "batch.completed" or "batch.failed" or "batch.expired" or 15 more

The event types that trigger deliveries to this endpoint.

--name: string

A human-readable name for the webhook endpoint.

--url: string

The HTTPS URL that receives webhook deliveries.

ReturnsExpand Collapse

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

id: string

The unique ID of the webhook endpoint.

created_at: number

The Unix timestamp when the endpoint was created.

event_types: array of string

The event types that trigger deliveries to this endpoint.

name: string

The human-readable name of the endpoint.

object: "webhook_endpoint"

The object type, which is always webhook_endpoint.

signing_secret: string

The endpoint’s signing secret. This is returned only when the endpoint is created or the secret is rotated.

signing_secret_hint: string

A masked hint for the endpoint’s signing secret.

url: string

The HTTPS URL that receives webhook deliveries.

updated_at: optional number

The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

Create Webhook Endpoint

CLI Tool

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

openai webhooks create \
  --api-key 'My API Key' \
  --event-type batch.completed \
  --name x \
  --url https://

200 example

{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}

Returns Examples

200 example

{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}