Webhook Details

The Webhook Details API is used to retrieve detailed information about a specific webhook by its unique ID.

This API is especially useful for:

  1. Verifying the configuration of a specific webhook.
  2. Checking the status and associated details of a registered webhook.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Path Parameters

ParamTypeRequiredDescriptionExample
idstringYesWebhook record ID."373593634-c272-4ed5-9896-1a4f1212125e"

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

FieldTypeDescriptionExample
webhookobjectDetails of the registered webhook event.-
webhook.idstringWebhook ID."91d138d0-2a31-49da-a61d-506ada8c3743"
webhook.addressstringWebhook notification URL."https://example.com/webhook"
webhook.topicstringWebhook event name."orders/cancelled"
webhook.created_atstringTime when the webhook was created."2024-12-30T23:50:38Z"
webhook.updated_atstringLast update time of the webhook."2024-12-30T23:50:38Z"
webhook.formatstringFormat 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.

FieldTypeExampleDescription
errorsArray[ "file number error"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorString "page not found"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
404Not FoundThe webhook Id is not found or empty."Record not found"

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!