API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Test Webhook Endpoint

client.webhooks.test(stringwebhookEndpointID, WebhookTestParams { event_type } body, RequestOptionsoptions?): WebhookEndpointTestResult { event_type, object, status_code, 2 more }

POST/webhook_endpoints/{webhook_endpoint_id}/test

Sends a sample event to a webhook endpoint for the authenticated project.

ParametersExpand Collapse

webhookEndpointID: string

body: WebhookTestParams { event_type }

ReturnsExpand Collapse

WebhookEndpointTestResult { event_type, object, status_code, 2 more }

event_type: string

The event type sent in the test.

object: "webhook_endpoint.test"

The object type, which is always webhook_endpoint.test.

status_code: number

The HTTP status code returned by the endpoint.

success: true

Whether the test request completed. Always true for returned results; use status_code to determine the endpoint response.

webhook_endpoint_id: string

The ID of the webhook endpoint that received the test.

Test Webhook Endpoint

TypeScript

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const webhookEndpointTestResult = await client.webhooks.test('whe_123', {
  event_type: 'batch.completed',
});

console.log(webhookEndpointTestResult.webhook_endpoint_id);

200 example

{
  "event_type": "event_type",
  "object": "webhook_endpoint.test",
  "status_code": 0,
  "success": true,
  "webhook_endpoint_id": "webhook_endpoint_id"
}

Returns Examples

200 example

{
  "event_type": "event_type",
  "object": "webhook_endpoint.test",
  "status_code": 0,
  "success": true,
  "webhook_endpoint_id": "webhook_endpoint_id"
}