Skip to content

List subscriptions

Endpoint: https://api.youcan.shop/resthooks/list

Method: GET

Required Scopes

  • read-rest-hooks

Responses

[200] Ok

json
[
  {
    "id": "f648e8f3-746d-46a0-8b75-53252a0d7d5a",
    "event": "order.created",
    "target_url": "https://yourdomain.com/webhooks/order.created"
  },
  {
    "id": "21525bb4-d3b5-481c-b6e4-b139fd87e02e",
    "event": "order.paid",
    "target_url": "https://yourdomain.com/webhooks/order.paid"
  },
  {
    "id": "b9bb8564-4196-4c0a-b5a8-714df0d3c34f",
    "event": "product.inventory.low",
    "target_url": "https://yourdomain.com/webhooks/inventory"
  }
]

The list includes deactivated subscriptions, see delivery and retries. Deactivated subscriptions do not receive deliveries and do not count toward the limit of 7 active subscriptions per event per client; subscribing to the same event and address activates them again.