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
Theme

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Update Webhook Endpoint

$ openai webhooks update
POST
/webhook_endpoints/{webhook_endpoint_id}

Updates a webhook endpoint for the authenticated project.

Update Webhook Endpoint

openai webhooks update \
  --api-key 'My API Key' \
  --webhook-endpoint-id whe_123
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}
Parameters
--webhook-endpoint-id: string

The ID of the webhook endpoint to update.

--event-type: optional array of "batch.completed" or "batch.failed" or "batch.expired" or 24 more

The complete set of event types that should trigger deliveries.

--name: optional string

A new human-readable name for the webhook endpoint.

--url: optional string

A new HTTPS URL that receives webhook deliveries.

Returns
webhook_endpoint: object { id, created_at, event_types, 5 more }
id: string

The unique ID of the webhook endpoint.

created_at: number

The Unix timestamp when the endpoint was created.

event_types: array of 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_hint: string

A masked hint for the endpoint’s signing secret.

url: string

The HTTPS URL that receives webhook deliveries.

updated_at: optional number

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

Returns Examples
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}