List webhooks
curl --request GET \
--url https://api.healos.ai/ext-api/v1/webhooks \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/webhooks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3f2b8c1e-0000-4000-8000-000000000001",
"name": "<string>",
"url": "<string>",
"event_type": "NOTE_CREATED",
"format": "JSON",
"description": "<string>",
"header_names": [
"Authorization"
],
"active": true,
"created_at": "2026-11-03T14:00:00.000Z"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}Webhooks
List webhooks
The webhooks of the user who created this API key, the same list as the dashboard’s Webhooks page. Header values are never returned. Requires the webhooks:read scope.
GET
/
webhooks
List webhooks
curl --request GET \
--url https://api.healos.ai/ext-api/v1/webhooks \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/webhooks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3f2b8c1e-0000-4000-8000-000000000001",
"name": "<string>",
"url": "<string>",
"event_type": "NOTE_CREATED",
"format": "JSON",
"description": "<string>",
"header_names": [
"Authorization"
],
"active": true,
"created_at": "2026-11-03T14:00:00.000Z"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}| Requirement | Detail |
|---|---|
| Scope | webhooks:read |
| Rate limit | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| Cost | Free |
Safety
- Writes data: No
- Safe to retry: Yes
- Contacts an outside system: None
- Dry run: Not needed (read-only).
Rolling out: this endpoint is on staging first and not yet on
api.healos.ai.404.
Header values are write-only: each webhook lists header_names, never the values.
Guide: Webhooks. Errors: Error catalog.Was this page helpful?

