Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Delete Webhook Endpoint

client.webhooks.delete(stringwebhookEndpointID, RequestOptionsoptions?): DeletedWebhookEndpoint { id, deleted, object }
DELETE/webhook_endpoints/{webhook_endpoint_id}

Deletes a webhook endpoint for the authenticated project.

ParametersExpand Collapse
webhookEndpointID: string
ReturnsExpand Collapse
DeletedWebhookEndpoint { id, deleted, object }
id: string

The ID of the deleted webhook endpoint.

deleted: boolean

Whether the endpoint was deleted.

object: "webhook_endpoint.deleted"

The object type, which is always webhook_endpoint.deleted.

Delete Webhook Endpoint

import OpenAI from 'openai';

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

const deletedWebhookEndpoint = await client.webhooks.delete('whe_123');

console.log(deletedWebhookEndpoint.id);
{
  "id": "id",
  "deleted": true,
  "object": "webhook_endpoint.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "webhook_endpoint.deleted"
}