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

Create Webhook

POST

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

Webhooks allow you to receive real-time data updates about various events.
For certain events, you can specify conditions under which the webhook should trigger,
allowing for more targeted data retrieval.

Supported Webhook Events

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

🔑Scopes

webhooks.read_write - Webhooks Read & Write

Authentication

If username and password are provided when creating a webhook, Zid will include a Basic Authentication header when sending webhook requests.

The values are combined in the format:

This string is then Base64 encoded and sent in the Authorization header.

Example

If the webhook was created with:

username = user
password = secret

The encoded value will be:

Zid will send webhook requests with the following header:

This allows partners to verify that the webhook request is coming from Zid.

Request

Header Params

Body Params application/json

Example

{
    "event": "category.create",
    "target_url": "https://webhook.site/79b40fa4-ace1-4589-882d-d30f16281f20",
    "original_id": 2404,
    "conditions": {},
    "username": "user",
    "password": "secret"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/webhooks' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "category.create",
    "target_url": "https://webhook.site/79b40fa4-ace1-4589-882d-d30f16281f20",
    "original_id": 2404,
    "conditions": {},
    "username": "user",
    "password": "secret"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "status": "object",
    "id": "e0384523-5601-48cd-af67-8b4188692ff6",
    "event": "category.create",
    "target_url": "https://webhook.site/79b40fa4-ace1-4589-882d-d30f16281f20",
    "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-03-12 08:02:57

List Webhooks

Delete Webhook

Create Webhook

Supported Webhook Events#

Authentication#

Request

Request Code Samples

Responses

Supported Webhook Events

Authentication