Webhook 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:

  1. Monitoring and auditing the number of registered webhooks.
  2. Validating if a specific webhook is already registered.
  3. Ensuring webhook registrations are within allowable limits.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Query Parameters

ParamTypeRequiredDescriptionExample
addressstringYesWebhook notification URL."https://example.com/webhook"
topicstringYesEvent name (e.g., orders/cancelled, app/subscriptions_update)."orders/cancelled"

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Success Response

FieldTypeDescriptionExample
countintegerTotal 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.

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

API Structure Overview

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