get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/webhooks/count
The Webhook Count API is used to retrieve the total number of webhooks registered with specific parameters, such as address or topic.
This API is especially useful for:
- Monitoring and auditing the number of registered webhooks.
- Validating if a specific webhook is already registered.
- Ensuring webhook registrations are within allowable limits.
Request Parameters
Public Request Parameters
Query Parameters
| Param | Type | Required | Description | Example |
|---|---|---|---|---|
address | string | Yes | Webhook notification URL. | "https://example.com/webhook" |
topic | string | Yes | Event name (e.g., orders/cancelled, app/subscriptions_update). | "orders/cancelled" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | integer | Total number of registered webhooks matching the filter. | 0 |
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 |