OpenAI API (unofficial showcase)
POST/webhook_endpoints/{webhook_endpoint_id}

Update Webhook Endpoint

Updates a webhook endpoint for the authenticated project.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
webhook_endpoint_idstringrequired
The ID of the webhook endpoint to update.
namestringoptional
A new human-readable name for the webhook endpoint.
urlstringoptional
A new HTTPS URL that receives webhook deliveries.
event_typesarray<string>optional
The complete set of event types that should trigger deliveries.

3 status codes
200Success
idstringrequired
The unique ID of the webhook endpoint.
objectstringrequired
The object type, which is always webhook_endpoint.
Allowed:webhook_endpointDefault:webhook_endpoint
created_atintegerrequired
The Unix timestamp when the endpoint was created.
updated_atintegeroptional
The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.
namestringrequired
The human-readable name of the endpoint.
urlstringrequired
The HTTPS URL that receives webhook deliveries.
event_typesarray<string>required
The event types that trigger deliveries to this endpoint.
signing_secret_hintstringrequired
A masked hint for the endpoint's signing secret.
400The webhook endpoint parameters are invalid or the requested URL or event types are not permitted.
errorobjectrequired
404The webhook endpoint was not found in the authenticated project.
errorobjectrequired

Error handling

A 400 is returned: The webhook endpoint parameters are invalid or the requested URL or event types are not permitted. A 404 is returned: The webhook endpoint was not found in the authenticated project.