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

List Webhooks

GET

https://api.zid.sa/v1/managers/webhooks

Webhooks enable your application to receive real-time notifications when specific events occur. This endpoint retrieves the list of webhook events that your application is currently subscribed to.

Supported Webhook Events

For more details on available events and their conditions,
please refer to the Supported Webhook Events page.

🔑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' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "status": "object",
    "data": [
        {
            "id": "b1a7ec47-c896-46ea-b5de-727c5bca40d0",
            "event": "category.create",
            "target_url": "https://webhook.site/b1590566-c28c-4c82-b948-8f8027e84335",
            "store_id": "d297fb8b-c322-412e-a2f4-ffa96dc57022",
            "conditions": [],
            "original_id": "2404",
            "subscriber": "8208974663db80265e9bfe7b222dcb18",
            "active": true,
            "doc": null
        }
    ],
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-06-06 22:03:56

Recover Broken Webhooks

Create Webhook

List Webhooks

Supported Webhook Events#

Request

Request Code Samples

Responses

Supported Webhook Events