apicheats.dev openai/llms.txt Raw .md
POST

POST /webhook_endpoints — OpenAI API

OpenAI API key (required); https://api.openai.com/v1

OpenAI API

Create Webhook Endpoint

Base URL
https://api.openai.com/v1
Auth
Authorization: Bearer <OPENAI_API_KEY>
Last verified
2026-09-18 · upstream hash matched
Actions Try in browser
Agents: curl -H "Accept: text/markdown" this URL
→ 233 tokens · Vary: Accept

Critical gotchas

The Responses API is the primary interface for new text and tool workflows; Chat Completions remains a separate compatibility API.

Audio transcription uploads use multipart form data rather than a JSON request body.

cURL

curl -X POST 'https://api.openai.com/v1/webhook_endpoints' \  -H "Authorization: Bearer $OPENAI_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "name": "example-name",  "url": "https://example.com",  "event_types": [    "batch.completed"  ]}'

Parameters

Name In Type Required Description
name body string Yes A human-readable name for the webhook endpoint.
url body string Yes The HTTPS URL that receives webhook deliveries.
event_types body string[] Yes The event types that trigger deliveries to this endpoint.

Response 200 OK

{
  "id": "string",
  "object": "webhook_endpoint",
  "created_at": 0,
  "updated_at": 0,
  "name": "string",
  "url": "string",
  "event_types": [
    "string"
  ],
  "signing_secret_hint": "string",
  "signing_secret": "string"
}
Get a free OpenAI API key → sponsored