Search for Webhook Subscriptions
Header Parameters
Authorizationstring
Query Parameters
statusstring
Filter subscriptions by their status.
Enum values:
ENABLEDPENDINGDISABLEDdomainstring
The domain of subscription.
Enum values:
AUTHORIZATIONDRIVERCARDVEHICLEactive_onstring
Filter subscriptions that are active on the given date (i.e. start date is on/before this date and end date is null or after this date).
callback_urlstring
The callback url of subscription.
Min length
1
Pattern
^https?://.+
pageinteger
If a query returns multiple pages (total records/size) you can use this value to select a specific page to return. Defaults to zero.
Default value
0
sizeinteger
Number of records per page.
Minimum
1
Maximum
1000
Default value
25
sortstring
Sorting criteria in the format: property asc|desc. Default sort order is ascending.
Default value
start_date
Response
200
Object
List of Webhook Subscriptions matching the search params.
Response Attributes
itemsarray
Show child attributes
nextobject
Show child attributes
notestring
Warning or informational note about the response if any.
prevobject
Show child attributes
total_countinteger
Total number of items.
400
Object
400 (Bad Request)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object
401 (Unauthorized)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object
500 (Internal Server Error)
Response Attributes
detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?
Response
Was this section helpful?