List Webhook Subscriptions

GET 
/v1/webhook-subscriptions

List Webhook Subscriptions

Request

Query Parameters

deleted boolean

Shows deleted Webhook Subscriptions

event WebhookEventsEnum
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, validation_submission.updated, donation.hosted.payment_received, donation.created, donation.settled, donation.disbursed, donation.payment_successful, donation.cancelled, donation.reassigned]
Filter by event
Example: validation_request.rejected
cursor string

A cursor that points to where to start the page

pageSize integer
How many items per page, for pagination.
Default value: 25

Responses

200

Successfully lists Webhook Subscriptions

application/json

Schema

Schema

data

object[]

Array [

idstring

Example: webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

eventsWebhookEventsEnum (string)[]

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, validation_submission.updated, donation.hosted.payment_received, donation.created, donation.settled, donation.disbursed, donation.payment_successful, donation.cancelled, donation.reassigned]

urlwebsite

Example: https://example.com/my-webhook-handler

secretstring

createdAtdate-time

updatedAtdate-timenullable

deletedAtdate-timenullable

]

objectstring
Example: webhook_subscription
totalResultsinteger
Example: 33
pageSizeinteger
Example: 25

_links

object

currentstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

nextstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

prevstring

Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D

Example (from schema)

{
  "data": [
    {
      "id": "webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "events": [
        "validation_request.approved"
      ],
      "url": "https://example.com/my-webhook-handler",
      "secret": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "deletedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "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"
  }
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

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"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}