OMomnistack-sh

Retrieve Webhook Endpoint

Changed on

Retrieves a webhook endpoint for the authenticated project.

get/webhook_endpoints/{webhook_endpoint_id}

Request

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

Path parameters

webhook_endpoint_idstring required
Example:whe_123

The ID of the webhook endpoint to retrieve.

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.

Changes

  • 487892d3954eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • info

      endpoint added