List Webhook Endpoints | OpenAI API (unofficial showcase)

2 parameters

limitintegeroptional

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

afterstringoptional

ID of the last webhook endpoint from the previous page.

3 status codes

200Success

objectstringrequired

The object type, which is always list.

Allowed:listDefault:list

dataarray<object>required

The webhook endpoints in this page.

first_idstringrequired

The ID of the first endpoint in this page.

last_idstringrequired

The ID of the last endpoint in this page.

has_morebooleanrequired

Whether more webhook endpoints are available.

400The request parameters are invalid.

errorobjectrequired

404The pagination cursor does not identify a webhook endpoint in the authenticated project.

errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid. A 404 is returned: The pagination cursor does not identify a webhook endpoint in the authenticated project.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.webhookEndpoints.list({
  limit: 20,
  after: "example",
});

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "webhook_endpoint",
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z",
      "name": "Example Name",
      "url": "https://example.com",
      "event_types": [
        "example_value"
      ],
      "signing_secret_hint": "example_value"
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response

Errors