Webhooks

Create a webhook

Each notification counts as one request; retries don't. Addresses watched by address webhooks and streams together, each counted once, are capped per plan (Free 500, Hobby 1,000, Starter 10,000, Professional 25,000, Behemoth 100,000; Free's on testnets); past that, 403.

post/webhooks

Request

  • Base URL: https://sochain.com/api/v3
  • URL: https://sochain.com/api/v3/webhooks
  • Auth: API key in header API-KEY

Request body

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 unless bucket is given. Free plans: BTCTEST, LTCTEST, DOGETEST or ZECTEST.

urlstring uri required

Your HTTPS endpoint, on a public host (not sochain.com).

bucketstring

Letters, numbers, - and _, up to 64 characters. Unique within your account.

addressesstring[]

address.transaction without a bucket: the addresses to watch, up to 1,000 in this call (add more with POST /webhooks/{id}/addresses).

transactionsstring[]

transaction.confirmation: the transaction IDs to track, up to 1,000 in this call (add more with POST /webhooks/{id}/transactions).

notify_atinteger[]

Confirmation counts to notify at, from 0 (first seen) to 100; transaction.confirmation from 1. Defaults: [0, 1] for address.transaction, [1, 2, 3, 6] for transaction.confirmation.

labelstring

Optional, for you: shown on the dashboard.

thresholdnumber

fees.below / fees.above: the fee rate (sat/vB, lit/vB or koinu/vB) to cross.

Response

Success.

status'success' required

Changes

No recorded changes to this operation across all 1 revision of this API.