Query Webhook Subscriptions

Return a paginated list of matching webhook subscriptions.

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

merchantId
Array of strings

Only include webhook merchant subscriptions for this given list of sub-merchants. Only relevant for marketplace users interested in merchant level subscriptions.

marketplaceId
string

Only include webhook marketplace subscriptions for the given marketplaceId. Only relevant for admin users interested in marketplace level subscriptions.

status
string (WebhookSubscriptionState)

Filter by subscription status

Enum: "Active" "Suspended"
Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/webhooks
Request samples
Response samples
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.