resources/webhooks/methods/retrieve/index.md +0 −71 deleted
File Deleted View Diff
1## Retrieve Webhook Endpoint
2
3**get** `/webhook_endpoints/{webhook_endpoint_id}`
4
5Retrieves a webhook endpoint for the authenticated project.
6
7### Path Parameters
8
9- `webhook_endpoint_id: string`
10
11### Returns
12
13- `WebhookEndpoint object { id, created_at, event_types, 5 more }`
14
15 - `id: string`
16
17 The unique ID of the webhook endpoint.
18
19 - `created_at: number`
20
21 The Unix timestamp when the endpoint was created.
22
23 - `event_types: array of string`
24
25 The event types that trigger deliveries to this endpoint.
26
27 - `name: string`
28
29 The human-readable name of the endpoint.
30
31 - `object: "webhook_endpoint"`
32
33 The object type, which is always webhook_endpoint.
34
35 - `"webhook_endpoint"`
36
37 - `signing_secret_hint: string or null`
38
39 A masked hint for the endpoint's signing secret.
40
41 - `url: string`
42
43 The HTTPS URL that receives webhook deliveries.
44
45 - `updated_at: optional number`
46
47 The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.
48
49### Example
50
51```http
52curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID \
53 -H "Authorization: Bearer $OPENAI_API_KEY"
54```
55
56#### Response
57
58```json
59{
60 "id": "id",
61 "created_at": 0,
62 "event_types": [
63 "string"
64 ],
65 "name": "name",
66 "object": "webhook_endpoint",
67 "signing_secret_hint": "signing_secret_hint",
68 "url": "url",
69 "updated_at": 0
70}
71```