Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Health Summary

GET

https://api.zid.sa/v1/managers/webhooks/health-summary

Retrieves the health status of all webhooks subscribed to a specific store by your application. Each webhook is categorized as Healthy, Degraded, or Broken based on its recent delivery performance and availability.

🔑Scopes

third_webhook_read - Webhooks Read

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.zid.sa/v1/managers/webhooks/health-summary' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "status": "object",
    "data": {
        "healthy": 54,
        "degraded": 0,
        "broken": 0
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-06-08 09:10:15

Product Category

Broken Webhooks