# Get a webhook

`GET https://api.rarebl.com/open/hooks/get`

Reads a subscription. Secrets are not returned again.

**Rate class:** read (5 requests per second, burst 20, per IP). **Available since:** Open API v2.

## Request

Send the parameters as query parameters (GET) or as a JSON object (POST with `Content-Type: application/json`). They are identical either way. No API key is needed: `X-API-KEY` is reserved and ignored.

Example: `curl "https://api.rarebl.com/open/hooks/get?id=hk_3f9a2c71e0b84d56"`

## Headers

| Header | Required | Description |
| --- | --- | --- |
| `X-Hook-Token` | Yes | The `manageToken` returned once by [hooks/create](https://docs.rarebl.com/api/hooks/create). Sent in a header, never in the URL. Example: `YOUR_MANAGE_TOKEN`. |

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The webhook subscription id returned by hooks/create. |

## Responses

### API200 (HTTP 200): OK

The subscription.

```json
{
  "status": 1,
  "code": "API200",
  "message": "success",
  "data": {
    "id": "hk_3f9a2c71e0b84d56",
    "type": "tx.confirmations",
    "chain": "btc",
    "url": "https://example.com/hooks/rarebl",
    "txid": "9dedeb8092d6f026d235e3beb24337ba5657635a38cc949f70c0f28ea15e30db",
    "confirmations": 6,
    "status": "active",
    "createdAt": "2026-11-15T01:12:07Z"
  },
  "go": null,
  "meta": {
    "requestid": "0123456789abcdef",
    "notices": []
  }
}
```

### API404 (HTTP 404): Not Found

The webhook does not exist.

```json
{
  "status": 0,
  "code": "API404",
  "message": "Webhook not found.",
  "data": null,
  "go": null,
  "meta": {
    "requestid": "0123456789abcdef",
    "notices": []
  }
}
```

### API429 (HTTP 429): Too Many Requests

Rate limited (read class: 5 requests per second, burst 20, per IP). A `Retry-After` header says how long to wait, in seconds.

```json
{
  "status": 0,
  "code": "API429",
  "message": "Too many requests. Please retry shortly.",
  "data": null,
  "go": null,
  "meta": {
    "requestid": "0123456789abcdef",
    "notices": []
  }
}
```

## Notes

- Needs the header `X-Hook-Token: <manageToken>`.