API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Webhook Endpoint

webhooks.create(**kwargs) -> WebhookEndpointWithSecret { id, created_at, event_types, 6 more }

POST/webhook_endpoints

Creates a webhook endpoint for the authenticated project.

ParametersExpand Collapse

event_types: Array[:"batch.completed" | :"batch.failed" | :"batch.expired" | 15 more]

The event types that trigger deliveries to this endpoint.

name: String

A human-readable name for the webhook endpoint.

minLength1

maxLength256

url: String

The HTTPS URL that receives webhook deliveries.

maxLength2048

ReturnsExpand Collapse

class WebhookEndpointWithSecret { id, created_at, event_types, 6 more }

id: String

The unique ID of the webhook endpoint.

created_at: Integer

The Unix timestamp when the endpoint was created.

formatunixtime

event_types: Array[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: Integer

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

formatunixtime

Create Webhook Endpoint

Ruby

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

webhook_endpoint_with_secret = openai.webhooks.create(event_types: [:"batch.completed"], name: "x", url: "https://")

puts(webhook_endpoint_with_secret)

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
}