Webhook Subscribers
Return a list of Webhook Subscribers
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Webhook Subscribers
Return a list of Webhook Subscribers
Returns a list of Webhook Subscribers
GET
/
api
/
v2
/
platform
/
webhooks
/
subscribers
curl --request GET \
--url http://{defaultHost}/api/v2/platform/webhooks/subscribers \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "5",
"type": "subscriber",
"attributes": {
"url": "https://www.url5.com/",
"active": true,
"subscriptions": [
"*"
],
"created_at": "2022-11-08T19:35:58.830Z",
"updated_at": "2022-11-08T19:35:58.830Z"
}
},
{
"id": "6",
"type": "subscriber",
"attributes": {
"url": "https://www.url6.com/",
"active": true,
"subscriptions": [
"*"
],
"created_at": "2022-11-08T19:35:58.831Z",
"updated_at": "2022-11-08T19:35:58.831Z"
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/webhooks/subscribers?page=1&per_page=&filter[active_eq]=&filter[url_cont]=",
"next": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page="
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/vnd.api+json
Records returned
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/webhooks/subscribers \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "5",
"type": "subscriber",
"attributes": {
"url": "https://www.url5.com/",
"active": true,
"subscriptions": [
"*"
],
"created_at": "2022-11-08T19:35:58.830Z",
"updated_at": "2022-11-08T19:35:58.830Z"
}
},
{
"id": "6",
"type": "subscriber",
"attributes": {
"url": "https://www.url6.com/",
"active": true,
"subscriptions": [
"*"
],
"created_at": "2022-11-08T19:35:58.831Z",
"updated_at": "2022-11-08T19:35:58.831Z"
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/webhooks/subscribers?page=1&per_page=&filter[active_eq]=&filter[url_cont]=",
"next": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/webhooks/subscribers?filter%5Bactive_eq%5D=&filter%5Burl_cont%5D=&page=1&per_page="
}
}