API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Webhook Endpoints

client.Webhooks.List(ctx, query) (*CursorPage[WebhookEndpoint], error)

GET/webhook_endpoints

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

ParametersExpand Collapse

query WebhookListParams

After param.Field[string]Optional

ID of the last webhook endpoint from the previous page.

Limit param.Field[int64]Optional

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

minimum1

maximum100

ReturnsExpand Collapse

type WebhookEndpoint struct{…}

ID string

The unique ID of the webhook endpoint.

CreatedAt int64

The Unix timestamp when the endpoint was created.

formatunixtime

EventTypes []string

The event types that trigger deliveries to this endpoint.

Name string

The human-readable name of the endpoint.

Object WebhookEndpoint

The object type, which is always webhook_endpoint.

SigningSecretHint string

A masked hint for the endpoint’s signing secret.

URL string

The HTTPS URL that receives webhook deliveries.

UpdatedAt int64Optional

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

Go

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
  "github.com/openai/openai-go/webhooks"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Webhooks.List(context.TODO(), webhooks.WebhookListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

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