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 Events
Return a list of Webhook Events
Returns a list of Webhook Events
GET
/
api
/
v2
/
platform
/
webhooks
/
events
curl --request GET \
--url http://{defaultHost}/api/v2/platform/webhooks/events \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "event",
"attributes": {
"execution_time": 14933,
"name": "order.canceled",
"request_errors": "",
"response_code": "200",
"success": true,
"url": "https://www.url1.com/",
"created_at": "2022-11-08T19:35:58.544Z",
"updated_at": "2022-11-08T19:35:58.544Z"
},
"relationships": {
"subscriber": {
"data": {
"id": "1",
"type": "subscriber"
}
}
}
},
{
"id": "2",
"type": "event",
"attributes": {
"execution_time": 64917,
"name": "order.canceled",
"request_errors": "",
"response_code": "200",
"success": true,
"url": "https://www.url2.com/",
"created_at": "2022-11-08T19:35:58.547Z",
"updated_at": "2022-11-08T19:35:58.547Z"
},
"relationships": {
"subscriber": {
"data": {
"id": "2",
"type": "subscriber"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/webhooks/events?page=1&per_page=&include=&filter[name_eq]=&filter[request_errors_cont]=&filter[response_code_eq]=&filter[success_eq]=&filter[url_cont]=",
"next": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page="
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Response
200
application/vnd.api+json
Records returned
The response is of type object
.
curl --request GET \
--url http://{defaultHost}/api/v2/platform/webhooks/events \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "event",
"attributes": {
"execution_time": 14933,
"name": "order.canceled",
"request_errors": "",
"response_code": "200",
"success": true,
"url": "https://www.url1.com/",
"created_at": "2022-11-08T19:35:58.544Z",
"updated_at": "2022-11-08T19:35:58.544Z"
},
"relationships": {
"subscriber": {
"data": {
"id": "1",
"type": "subscriber"
}
}
}
},
{
"id": "2",
"type": "event",
"attributes": {
"execution_time": 64917,
"name": "order.canceled",
"request_errors": "",
"response_code": "200",
"success": true,
"url": "https://www.url2.com/",
"created_at": "2022-11-08T19:35:58.547Z",
"updated_at": "2022-11-08T19:35:58.547Z"
},
"relationships": {
"subscriber": {
"data": {
"id": "2",
"type": "subscriber"
}
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/webhooks/events?page=1&per_page=&include=&filter[name_eq]=&filter[request_errors_cont]=&filter[response_code_eq]=&filter[success_eq]=&filter[url_cont]=",
"next": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/webhooks/events?filter%5Bname_eq%5D=&filter%5Brequest_errors_cont%5D=&filter%5Bresponse_code_eq%5D=&filter%5Bsuccess_eq%5D=&filter%5Burl_cont%5D=&include=&page=1&per_page="
}
}
Assistant
Responses are generated using AI and may contain mistakes.