resources/webhooks/methods/list/index.md +0 −107 deleted
File Deleted View Diff
1## List Webhook Endpoints
2
3**get** `/webhook_endpoints`
4
5Returns webhook endpoints for the authenticated project in newest-first order.
6
7### Query Parameters
8
9- `after: optional string or null`
10
11 ID of the last webhook endpoint from the previous page.
12
13- `limit: optional number`
14
15 Maximum number of webhook endpoints to return. Defaults to 20.
16
17### Returns
18
19- `WebhookEndpointList object { data, first_id, has_more, 2 more }`
20
21 - `data: array of WebhookEndpoint`
22
23 The webhook endpoints in this page.
24
25 - `id: string`
26
27 The unique ID of the webhook endpoint.
28
29 - `created_at: number`
30
31 The Unix timestamp when the endpoint was created.
32
33 - `event_types: array of string`
34
35 The event types that trigger deliveries to this endpoint.
36
37 - `name: string`
38
39 The human-readable name of the endpoint.
40
41 - `object: "webhook_endpoint"`
42
43 The object type, which is always webhook_endpoint.
44
45 - `"webhook_endpoint"`
46
47 - `signing_secret_hint: string or null`
48
49 A masked hint for the endpoint's signing secret.
50
51 - `url: string`
52
53 The HTTPS URL that receives webhook deliveries.
54
55 - `updated_at: optional number`
56
57 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.
58
59 - `first_id: string or null`
60
61 The ID of the first endpoint in this page.
62
63 - `has_more: boolean`
64
65 Whether more webhook endpoints are available.
66
67 - `last_id: string or null`
68
69 The ID of the last endpoint in this page.
70
71 - `object: "list"`
72
73 The object type, which is always list.
74
75 - `"list"`
76
77### Example
78
79```http
80curl https://api.openai.com/v1/webhook_endpoints \
81 -H "Authorization: Bearer $OPENAI_API_KEY"
82```
83
84#### Response
85
86```json
87{
88 "data": [
89 {
90 "id": "id",
91 "created_at": 0,
92 "event_types": [
93 "string"
94 ],
95 "name": "name",
96 "object": "webhook_endpoint",
97 "signing_secret_hint": "signing_secret_hint",
98 "url": "url",
99 "updated_at": 0
100 }
101 ],
102 "first_id": "first_id",
103 "has_more": true,
104 "last_id": "last_id",
105 "object": "list"
106}
107```