Retrieve

Get a paginated list of all webhook subscriptions for a webshop.

GET /1.0/webhooks.json

Query Parameters

id int (required)

The unique webshop ID.

code string (required)

Your personal API code.

page integer

The page number for pagination. Default 1

Response

Success (200 OK)

Returns an array of webhook subscriptions with pagination information in the headers.

[
    {
        "id": 123,
        "topic": "reviews.created",
        "url": "https://your-domain.com/webhook",
        "secret": "your_webhook_secret_hash",
        "is_active": true
    },
    {
        "id": 124,
        "topic": "reviews.updated",
        "url": "https://your-domain.com/webhook-updates",
        "secret": "another_webhook_secret_hash",
        "is_active": false
    }
]

Headers:

• X-Total: Total number of webhook subscriptions (useful for pagination)

Pagination:

• Results are limited to 20 items per page
• Results are ordered by creation date (newest first)

Error Responses

Unauthorized (401)

{
    "status": "error",
    "message": "Unauthorized"
}

Notes

• Each webhook subscription includes its secret which should be used to verify webhook signatures (see Subscribe to Webhook)