Skip to main content
GET
/
v1
/
webhook-subscriptions
/
{id}
curl --request GET \
  --url https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123 \
  --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"
    }
  }
}
Retrieve a single webhook subscription by its ID. The signing secret is never included in this response.

​
Path parameters

ParameterTypeDescription
idstringThe webhook subscription ID

​
Errors

StatusScenario
401Missing or invalid API key
404No subscription with this ID exists for the shop
429Rate limit exceeded (6 requests/second)
curl --request GET \
  --url https://api.mageloyalty.com/v1/webhook-subscriptions/whsub_abc123 \
  --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"
    }
  }
}