API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Webhook Endpoints

webhooks.list(WebhookListParams**kwargs) -> SyncCursorPage[WebhookEndpoint]

GET/webhook_endpoints

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

ParametersExpand Collapse

after: Optional[str]

ID of the last webhook endpoint from the previous page.

limit: Optional[int]

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

minimum1

maximum100

ReturnsExpand Collapse

class WebhookEndpoint: …

id: str

The unique ID of the webhook endpoint.

created_at: int

The Unix timestamp when the endpoint was created.

formatunixtime

event_types: List[str]

The event types that trigger deliveries to this endpoint.

name: str

The human-readable name of the endpoint.

object: Literal["webhook_endpoint"]

The object type, which is always webhook_endpoint.

signing_secret_hint: Optional[str]

A masked hint for the endpoint’s signing secret.

url: str

The HTTPS URL that receives webhook deliveries.

updated_at: Optional[int]

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

formatunixtime

List Webhook Endpoints

Python

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
page = client.webhooks.list()
page = page.data[0]
print(page.id)

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"
}