Retrieve all configured webhooks.
Endpoint:
HTTP Method: GET
Path: /v2/webhooks
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/webhooks/GetWebhooks
Authentication
Two header-based authentication methods are required:
| Header | Type | In | Description |
| x-api-key | token | header | API key credential |
| x-client-id | token | header | Client identifier credential |
Query Parameters
| Parameter | Type | Required | Default | Range | Description |
| page | integer | No |
1 |
1 ≤ value ≤ 100 | Page number for pagination. |
| perPage | integer | No |
10 |
1 ≤ value ≤ 100 | Number of items per page. |
Example Request -- JSON
fetch("https://api.propelus.com/v2/webhooks", {
method: "GET",
headers: {
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
}
})Example Request -- cURL
curl -X GET "https://api.propelus.com/v2/webhooks" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>"Responses
200 — Success
Returns a paginated list of configured webhooks. count is the number of items on the current page, total the total across all pages, with nextPage / prevPage pagination links.
{
"count": 0,
"total": 0,
"webhooks": [
{
"eventType": "credentialVerified",
"url": "https://my.site/externalEvents",
"signature": {
"key": "a3f8c92e5d1b4f7a9e6c2d8b3f5a1c4e"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "active",
"addedAt": "2026-05-28T10:15:30.000Z",
"updatedAt": "2026-05-28T11:42:00.000Z"
}
],
"nextPage": "/v2/webhooks?page=3&perPage=10",
"prevPage": "/v2/webhooks?page=1&perPage=10"
}Error Responses
Standardized error bodies. Validation-style errors (400, 401, 403, 404, 4XX) include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/webhooks/GetWebhooks#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error