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

webhooks.update(webhook_endpoint_id, **kwargs) -> WebhookEndpoint { id, created_at, event_types, 5 more }
POST
/webhook_endpoints/{webhook_endpoint_id}

Updates a webhook endpoint for the authenticated project.

Parameters
webhook_endpoint_id: String
event_types: Array[:"batch.completed" | :"batch.failed" | :"batch.expired" | 24 more]

The complete set of event types that should trigger deliveries.

minItems1
name: String

A new human-readable name for the webhook endpoint.

minLength1
maxLength256
url: String

A new HTTPS URL that receives webhook deliveries.

maxLength2048
Returns
class WebhookEndpoint { id, created_at, event_types, 5 more }
id: String

The unique ID of the webhook endpoint.

created_at: Integer

The Unix timestamp when the endpoint was created.

formatunixtime
event_types: Array[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: Integer

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

formatunixtime

Update Webhook Endpoint

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

webhook_endpoint = openai.webhooks.update("whe_123")

puts(webhook_endpoint)
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
}
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
}