← API referenceChanges & events · API access unavailable
API REFERENCE / CHANGES & EVENTS
GET /v1/webhooks
List this integration’s webhook subscriptions and verification status.
Request fields
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Credential scoped to the authorized resource. |
| Query | cursor | string | No | Opaque pagination cursor. |
Request example
Example request
GET /v1/webhooks
Authorization: Bearer <scoped token>HTTP status codes
| Status | Meaning |
|---|---|
200 OK | Success response shown below. |
400 Bad Request | Invalid pagination cursor. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
items | object[] | [1 shown] |
items[].id | string | wh_123 |
items[].url | string | https://example.app/atom/events |
items[].status | string | active |
items[].event_types | string[] | [1 shown] |
next_cursor | string | null | null |
Response example
Example response
200 OK
Content-Type: application/json
{
"items": [
{
"id": "wh_123",
"url": "https://example.app/atom/events",
"status": "active",
"event_types": [
"file.available"
]
}
],
"next_cursor": null
}How it works
Do not return signing secrets after initial issuance or rotation. A webhook is only a notification hint; use the change feed for catch-up.
