OpenAI API (unofficial showcase)
POST/webhook_endpoints

Create Webhook Endpoint

Creates a webhook endpoint for the authenticated project.

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

3 body fields
namestringrequired
A human-readable name for the webhook endpoint.
urlstringrequired
The HTTPS URL that receives webhook deliveries.
event_typesarray<string>required
The event types that trigger deliveries to this endpoint.

2 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.
signing_secretstringrequired
The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.
400The webhook endpoint parameters are invalid or the endpoint cannot be created with the requested URL or event types.
errorobjectrequired

Error handling

A 400 is returned: The webhook endpoint parameters are invalid or the endpoint cannot be created with the requested URL or event types.