get https://{shopdomain}.myshoplaza.com/openapi/2022-01/webhooks/
The Webhook Details API is used to retrieve detailed information about a specific webhook by its unique ID.
This API is especially useful for:
- Verifying the configuration of a specific webhook.
- Checking the status and associated details of a registered webhook.
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
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
webhook | object | Details of the registered webhook event. | - |
webhook.id | string | Webhook ID. | "91d138d0-2a31-49da-a61d-506ada8c3743" |
webhook.address | string | Webhook notification URL. | "https://example.com/webhook" |
webhook.topic | string | Webhook event name. | "orders/cancelled" |
webhook.created_at | string | Time when the webhook was created. | "2024-12-30T23:50:38Z" |
webhook.updated_at | string | Last update time of the webhook. | "2024-12-30T23:50:38Z" |
webhook.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 | |
| 404 | Not Found | The webhook Id is not found or empty. | "Record not found" |
API Structure Overview
Responses