API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Webhook Endpoints

$ openai webhooks list

GET/webhook_endpoints

Returns webhook endpoints for the authenticated project in newest-first order.

ParametersExpand Collapse

--after: optional string

ID of the last webhook endpoint from the previous page.

--limit: optional number

Maximum number of webhook endpoints to return. Defaults to 20.

ReturnsExpand Collapse

webhook_endpoint_list: object { data, first_id, has_more, 2 more }

data: array of WebhookEndpoint { id, created_at, event_types, 5 more }

The webhook endpoints in this page.

first_id: string

The ID of the first endpoint in this page.

has_more: boolean

Whether more webhook endpoints are available.

last_id: string

The ID of the last endpoint in this page.

object: "list"

The object type, which is always list.

List Webhook Endpoints

CLI Tool

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

openai webhooks list \
  --api-key 'My API Key'

200 example

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "event_types": [
        "string"
      ],
      "name": "name",
      "object": "webhook_endpoint",
      "signing_secret_hint": "signing_secret_hint",
      "url": "url",
      "updated_at": 0
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Returns Examples

200 example

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "event_types": [
        "string"
      ],
      "name": "name",
      "object": "webhook_endpoint",
      "signing_secret_hint": "signing_secret_hint",
      "url": "url",
      "updated_at": 0
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}