Skip to main content
GET
/
v1
/
webhook-subscriptions
curl --request GET \
  --url 'https://api.mageloyalty.com/v1/webhook-subscriptions?page[number]=1&page[size]=20' \
  --header 'Authorization: <api-key>'

{
  "data": [
    {
      "type": "webhook_subscription",
      "id": "whsub_abc123",
      "attributes": {
        "url": "https://example.com/webhooks/mage",
        "events": ["points.earned", "customer.tier_upgrade"],
        "is_active": true,
        "description": "Production points + tier sync",
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}
List all webhook subscriptions for the shop, newest first. The signing secret is never included in this response.

​
Query parameters

ParameterTypeDescription
page[number]integerPage number (default: 1)
page[size]integerResults per page (default: 20, max: 100)

​
Errors

StatusScenario
401Missing or invalid API key
429Rate limit exceeded (6 requests/second)
curl --request GET \
  --url 'https://api.mageloyalty.com/v1/webhook-subscriptions?page[number]=1&page[size]=20' \
  --header 'Authorization: <api-key>'

{
  "data": [
    {
      "type": "webhook_subscription",
      "id": "whsub_abc123",
      "attributes": {
        "url": "https://example.com/webhooks/mage",
        "events": ["points.earned", "customer.tier_upgrade"],
        "is_active": true,
        "description": "Production points + tier sync",
        "created_at": "2024-01-01T00:00:00.000Z",
        "updated_at": "2024-01-01T00:00:00.000Z"
      }
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}