List Webhook Subscriptions
GET/v1/webhook-subscriptions
List Webhook Subscriptions
Request​
Query Parameters
Shows deleted Webhook Subscriptions
Possible values: [validation_request.approved
, validation_request.rejected
, agent_verification.pending_review
, agent_verification.pending_user_verification
, agent_verification.approved
, agent_verification.rejected
, monitoring_subscription.updated
, eligibility_subscription.updated
, validation_submission.created
, validation_submission.succeeded
, validation_submission.failed
, donation.hosted.payment_received
]
Filter by event
A cursor that points to where to start the page
Default value: 25
How many items per page, for pagination.
Responses​
- 200
- 400
- 401
- 403
Successfully lists Webhook Subscriptions
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
Possible values: [validation_request.approved
, validation_request.rejected
, agent_verification.pending_review
, agent_verification.pending_user_verification
, agent_verification.approved
, agent_verification.rejected
, monitoring_subscription.updated
, eligibility_subscription.updated
, validation_submission.created
, validation_submission.succeeded
, validation_submission.failed
, donation.hosted.payment_received
]
_links object
{
"data": [
{
"id": "webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"events": [
"validation_request.approved"
],
"url": "https://example.com/my-webhook-handler",
"secret": "string",
"createdAt": "2024-03-08T11:45:00.858Z",
"updatedAt": "2024-03-08T11:45:00.858Z",
"deletedAt": "2024-03-08T11:45:00.858Z"
}
],
"object": "webhook_subscription",
"totalResults": 33,
"pageSize": 25,
"_links": {
"current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
"prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- IncorrectParams
- CursorError
Schema
error object
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Error in cursor parameter
{
"error": {
"code": "pagination/cursor_error",
"title": "Bad request",
"message": "Unable to find the next page"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}