Skip to main content
GET
/
v1
/
webhooks
List Webhooks
curl --request GET \
  --url https://api.shoal.xyz/v1/webhooks \
  --header 'Authorization: Bearer <token>'
Returns all webhooks associated with your API key, ordered by most recently created.
Webhook management is available only on plans that include webhook access.

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/webhooks" \
  -H "Authorization: Bearer YOUR_API_KEY"
Python
import os, requests

API_KEY = os.environ.get("SHOAL_API_KEY", "YOUR_API_KEY")

r = requests.get(
    "https://api.shoal.xyz/v1/webhooks",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
print(r.json())
JavaScript
const API_KEY = process.env.SHOAL_API_KEY || 'YOUR_API_KEY';

const res = await fetch('https://api.shoal.xyz/v1/webhooks', {
  headers: { Authorization: `Bearer ${API_KEY}` },
});
console.log(await res.json());

​
Response (200)

{
  "data": [
    {
      "id": 12,
      "url": "https://example.com/shoal-webhook",
      "secret_hint": "****f6a8",
      "event_types": ["radar", "signal"],
      "active": true,
      "created_at": "2026-03-10T12:00:00Z",
      "updated_at": "2026-03-10T12:00:00Z"
    }
  ]
}
The full secret is only returned when you first create a webhook. List responses show a secret_hint (last 4 characters) for identification.