delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/webhooks/
The Delete Webhook API allows you to remove an existing webhook configuration from the system by providing the Webhook ID.
This API is especially useful for:
- Cleaning up unused or outdated webhook configurations.
- Removing webhook configurations that are no longer required.
- Managing webhook records to maintain a clean and efficient setup.
Request Parameters
Public Request Parameters
Path Parameters
| Param | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Webhook record ID. | "373593634-c272-4ed5-9896-1a4f1212125e" |
Response Explanation
Public Response Parameters
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 | [ "Record not found"] | 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 |
| 404 | Not Found | The webhook Id is not found or empty. | "Record not found" |