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

POST /webhook_endpoints/{webhook_endpoint_id}/test — OpenAI API

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

OpenAI API

Test 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
→ 198 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/whe_123/test' \  -H "Authorization: Bearer $OPENAI_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "event_type": "batch.completed"}'

Parameters

Name In Type Required Description
webhook_endpoint_id path string Yes The ID of the webhook endpoint to test.
event_type body string Yes Request body field event_type.

Response 200 OK

{
  "object": "webhook_endpoint.test",
  "webhook_endpoint_id": "string",
  "event_type": "string",
  "status_code": 0,
  "success": true
}
Get a free OpenAI API key → sponsored