SpyBara
Go Premium

resources/webhooks/methods/create/index.md 2026-09-15 22:59 UTC to 2026-09-16 22:58 UTC

This page contains 130 additions and 0 deletions.

2026
Wed 16 22:58 Fri 18 22:59

Create Webhook Endpoint

post /webhook_endpoints

Creates a webhook endpoint for the authenticated project.

Body Parameters

  • event_types: array of "batch.completed" or "batch.failed" or "batch.expired" or 15 more

    The event types that trigger deliveries to this endpoint.

    • "batch.completed"

    • "batch.failed"

    • "batch.expired"

    • "batch.cancelled"

    • "response.completed"

    • "response.failed"

    • "response.cancelled"

    • "response.incomplete"

    • "eval.run.succeeded"

    • "eval.run.failed"

    • "eval.run.canceled"

    • "fine_tuning.job.succeeded"

    • "fine_tuning.job.failed"

    • "fine_tuning.job.cancelled"

    • "realtime.call.incoming"

    • "video.completed"

    • "video.failed"

    • "safety.alert.created"

  • name: string

    A human-readable name for the webhook endpoint.

  • url: string

    The HTTPS URL that receives webhook deliveries.

Returns

  • WebhookEndpointWithSecret object { id, created_at, event_types, 6 more }

    • id: string

      The unique ID of the webhook endpoint.

    • created_at: number

      The Unix timestamp when the endpoint was created.

    • event_types: array of 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.

      • "webhook_endpoint"

    • signing_secret: string

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

    • signing_secret_hint: string or null

      A masked hint for the endpoint's signing secret.

    • url: string

      The HTTPS URL that receives webhook deliveries.

    • updated_at: optional number

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

Example

curl https://api.openai.com/v1/webhook_endpoints \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "event_types": [
            "batch.completed"
          ],
          "name": "x",
          "url": "https://"
        }'

Response

{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}