OMomnistack-sh

Create Webhook Endpoint

Changed on

Creates a webhook endpoint for the authenticated project.

post/webhook_endpoints

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/webhook_endpoints
  • Auth
    HTTP bearer

Request body

namestring required

A human-readable name for the webhook endpoint.

urlstring required

The HTTPS URL that receives webhook deliveries.

event_typesProjectEventTypeEnum[] required

The event types that trigger deliveries to this endpoint.

Response

Success

idstring required

The unique ID of the webhook endpoint.

object'webhook_endpoint' required

The object type, which is always webhook_endpoint.

created_atinteger required

The Unix timestamp when the endpoint was created.

updated_atinteger

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

namestring required

The human-readable name of the endpoint.

urlstring required

The HTTPS URL that receives webhook deliveries.

event_typesstring[] required

The event types that trigger deliveries to this endpoint.

signing_secret_hintstring nullable required

A masked hint for the endpoint's signing secret.

signing_secretstring required

The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.

Changes

  • ff5a4408cabbRevision changes
    • info

      added the new agent.environment.expired enum value to the request property /

    • info

      added the new agent.environment.suspended enum value to the request property /

  • 30eea8389a06Revision changes
    • info

      added the new agent.environment.failed enum value to the request property /

    • info

      added the new agent.environment.ready enum value to the request property /