get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/webhooks
The Webhook List API is used to retrieve a paginated list of registered webhooks with detailed information based on optional filters.
This API is especially useful for:
- Auditing existing webhook configurations.
- Filtering webhooks by event type, creation date, or update date.
- Managing large lists of webhooks with pagination.
Request Parameters
Public Request Parameters
Query Parameters
| Param | Type | Required | Description | Example |
|---|---|---|---|---|
address | string | No | Webhook notification URL to filter results. | "https://example.com/webhook" |
topic | string | No | The event name to filter results (e.g., orders/create). | "orders/create" |
created_at_min | string | No | Filter webhook records created after this date. | "2018-08-26T06:19:53Z" |
created_at_max | string | No | Filter webhook records created before this date. | "2018-08-26T06:19:53Z" |
updated_at_min | string | No | Filter webhook records updated after this date. | "2018-08-26T06:19:53Z" |
updated_at_max | string | No | Filter webhook records updated before this date. | "2018-08-26T06:19:53Z" |
limit | int32 | No | Number of results per page (default: 50, max: 250). | 50 |
page | int32 | No | Page number to retrieve. | 1 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
webhooks | array of object | Details of the registered webhook event. | - |
webhooks[].id | string | Webhook ID. | "91d138d0-2a31-49da-a61d-506ada8c3743" |
webhooks[].address | string | Webhook notification URL. | "https://example.com/webhook" |
webhooks[].topic | string | Webhook event name. | "orders/cancelled" |
webhooks[].created_at | string | Time when the webhook was created. | "2024-12-30T23:50:38Z" |
webhooks[].updated_at | string | Last update time of the webhook. | "2024-12-30T23:50:38Z" |
webhooks[].format | string | Format of the webhook response (e.g., json). | "json" |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | Unprocessable Entity | Invalid or empty Topic | "Topic is not allowed, allowed topic are: app/expired,app/uninstalled,cart/create,cart/update,collections/create,collections/delete,collections/update,customers/create,customers/delete,customers/update,fulfillments/create,fulfillments/update,orders/cancelled,orders/create,orders/delete,orders/finished,orders/fulfilled,orders/paid,orders/partially_fulfilled,orders/partially_refunded,orders/refunded,orders/update,procurements/create,procurements/update,products/create,products/delete,products/publish,products/unpublish,products/update,shop/update,stores/subscribe,suppliers/create,suppliers/delete,suppliers/update" |
| Invalid or empty address url | "Address is invalid" | ||
| invalid limit | "must be less than or equal to 250" | ||
| invalid page | "must be greater than or equal to 1" |