---
title: "List your webhooks"
method: GET
path: "/webhooks"
tags: ["Webhooks"]
---

# List your webhooks

`GET /webhooks`

## Request

- Base URL: `https://sochain.com/api/v3`
- URL: `https://sochain.com/api/v3/webhooks`
- Auth: one of:
  - API key in header `API-KEY`
  - API key in query parameter `api_key`

Webhooks per plan: Free 5 (testnets only), Hobby 10, Starter 100, Professional 5,000, Behemoth 25,000.

## Response `200`

Success.

- object
  - `status` 'success', required
  - `data` WebhookList, required
    - `webhooks` Webhook[], required
      - `id` string, required
      - `type` 'address.transaction' | 'transaction.confirmation' | 'block.new' | 'fees.below' | 'fees.above', required: block.reorged, transaction.replaced and transaction.dropped are delivered alongside these; they aren't created on their own.
      - `network` 'BTC' | 'LTC' | 'DOGE' | 'ZEC' | 'BTCTEST' | 'LTCTEST' | 'DOGETEST' | 'ZECTEST', required
      - `url` string, uri, required
      - `bucket` string, nullable
      - `notify_at` integer[]
      - `threshold` number, nullable
      - `label` string, nullable: Yours, as the dashboard shows it.
      - `status` 'unverified' | 'active' | 'paused'
      - `num_addresses` integer: Addresses it watches itself (address.transaction without a bucket).
      - `num_transactions` integer: Transactions it tracks (transaction.confirmation).
      - `created` integer: When it was made (Unix time).
      - `last_event_at` integer, nullable: When it last sent an event (Unix time); null before its first.
      - `failing_since` integer, nullable: When its deliveries started failing (Unix time); null while they succeed.
      - `verified` boolean
      - `verify_error` string, nullable: Why the last endpoint check failed, if it did.
      - `secret` string: Only in the answer to POST /webhooks: the signing secret, shown once.

## Other responses

- `400`: A bad parameter or body; the message says which.
- `401`: An invalid key, no key where one is needed (buckets, webhooks, /account_info), a locked account or expired plan, or both the month's requests and the keyless rate used up. Kept as 401, with this message, for v3 compatibility.
- `404`: Not found.
- `503`: Briefly unavailable; retry with backoff. May carry Retry-After.

---

[API](https://skmtc.dev/sochain/apis/sochain-api.md) · [All operations](https://skmtc.dev/sochain/apis/sochain-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sochain/apis/sochain-api/revisions/80682797b38f?raw)
