Endpoint
List webhook endpoints
GET
/v1/webhook_endpointsReturns your webhook endpoints, newest first, a page at a time. Filter by the time each was made, with created[gte] and created[lt].
- Scope a restricted key needs
webhooks:read- Publishable key
- Not allowed: secret or restricted key only
- Idempotency-Key
- Not used. A GET is already safe to repeat.
Parameters
| Parameter | Type and place | Meaning |
|---|---|---|
limit | integerquery | Items per page, 1 to 100. Default 20. |
starting_after | stringquery | An object id: return the items after it. |
ending_before | stringquery | An object id: return the items before it. |
created[gte] | string (date-time)query | Created at or after. Also created[gt], created[lte], created[lt]. |
created[lt] | string (date-time)query | Created before. |
Orrerie-Version | stringheader | API version date. Default: the version the key was created with. Example 2026-10-11. |
Example request
curl
curl https://api.orrerie.com/v1/webhook_endpoints \
-H "Authorization: Bearer $ORRERIE_SECRET_KEY"JavaScript
const response = await fetch("https://api.orrerie.com/v1/webhook_endpoints", {
headers: {
Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
},
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);Python
import os
import requests
response = requests.get(
"https://api.orrerie.com/v1/webhook_endpoints",
headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
timeout=30,
)
result = response.json()
if not response.ok:
raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)PHP
<?php
$request = curl_init('https://api.orrerie.com/v1/webhook_endpoints');
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
],
]);
$body = curl_exec($request);
if ($body === false) {
throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);Responses
200 OK
A list whose data holds webhook_endpoint objects. Headers: Orrerie-Request-Id.
Example response, 200
{
"object": "list",
"url": "/v1/webhook_endpoints",
"has_more": false,
"data": [
{
"id": "we_tx7j2vmn3r2px2vpwbtz5h7b",
"object": "webhook_endpoint",
"livemode": true,
"created": "2026-09-03T10:00:00.000Z",
"url": "https://acme.example/webhooks/orrerie",
"description": "Shop backend",
"enabled_events": [
"order.paid",
"order.underpaid",
"order.overpaid",
"order.expired",
"refund.confirmed"
],
"status": "enabled",
"disabled_reason": null,
"api_version": "2026-10-11",
"secret_last4": "k3Qw",
"previous_secret_expires_at": null,
"last_success_at": "2026-10-11T14:09:56.020Z",
"last_failure_at": null,
"metadata": {}
}
]
}Any other status: an error
A status of 400 or above answers with the error object. Branch on its code, never on its message.
Errors
This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.