Webhook Reference
When a webhook alert is fired, an HTTP POST message is delivered to the URL of your choice. The message contains a JSON object with the contents of the alert. Use this page as a reference for the JSON structure of each alert type.
Coin Listing Alert
Example JSON Alert
{
"type": "new_coin",
"message": "Ripple (XRP) was just listed on Coinbase Pro!",
"currency": "XRP",
"exchange": "Coinbase Pro"
}
"type": "new_coin",
"message": "Ripple (XRP) was just listed on Coinbase Pro!",
"currency": "XRP",
"exchange": "Coinbase Pro"
}
Price Alert
Example JSON Alert
{
"type": "price",
"message": "ZCash (ZEC) went above 150.00 USD on Gemini.",
"currency": "ZEC",
"direction": "above",
"price": "150.00",
"target_currency": "USD",
"exchange": "Gemini"
}
"type": "price",
"message": "ZCash (ZEC) went above 150.00 USD on Gemini.",
"currency": "ZEC",
"direction": "above",
"price": "150.00",
"target_currency": "USD",
"exchange": "Gemini"
}
Percent Price Alert
Example JSON Alert
{
"type": "percent_price",
"message": "ZCash (ZEC) went up by 6.4% in the last 6 hours on Gemini.",
"currency": "ZEC",
"direction": "above",
"percent": "6.00",
"current_price": "63.20",
"window": "360",
"exchange": "Gemini"
}
"type": "percent_price",
"message": "ZCash (ZEC) went up by 6.4% in the last 6 hours on Gemini.",
"currency": "ZEC",
"direction": "above",
"percent": "6.00",
"current_price": "63.20",
"window": "360",
"exchange": "Gemini"
}
Periodic Price Alert
Example JSON Alert
{
"type": "periodic_price",
"message": "The price of Bitcoin (BTC) is 10060.26 USD on Gemini.",
"currency": "BTC",
"target_currency": "USD",
"price": "10060.26",
"exchange": "Gemini"
}
"type": "periodic_price",
"message": "The price of Bitcoin (BTC) is 10060.26 USD on Gemini.",
"currency": "BTC",
"target_currency": "USD",
"price": "10060.26",
"exchange": "Gemini"
}
Bitcoin Mempool Alert
Example JSON Alert
{
"type": "bitcoin_mempool",
"message": "The size of the Bitcoin mempool went below 140MBs.",
"direction": "below",
"threshold": "140.0",
"metric": "megabytes"
}
"type": "bitcoin_mempool",
"message": "The size of the Bitcoin mempool went below 140MBs.",
"direction": "below",
"threshold": "140.0",
"metric": "megabytes"
}
Wallet Watch Alert
Example JSON Alert
{
"type": "wallet",
"message": "Your Ethereum wallet has been updated. Your Golem (GNT) balance changed by 4500 GNT.",
"blockchain": "ETH",
"address": "0x72c930652AcbcAc0ceFeA1e5b8e2D83A48523a9E",
"currency": "GNT",
"value": "4500.00"
}
"type": "wallet",
"message": "Your Ethereum wallet has been updated. Your Golem (GNT) balance changed by 4500 GNT.",
"blockchain": "ETH",
"address": "0x72c930652AcbcAc0ceFeA1e5b8e2D83A48523a9E",
"currency": "GNT",
"value": "4500.00"
}
Blockchain Alert
Example JSON Alert
{
"type": "blockchain",
"message": "The Bitcoin blockchain's Difficulty went above 13,798,783,827,516.0.",
"blockchain": "BTC",
"metric": "Difficulty",
"direction": "above",
"threshold": "13790000000000.0"
}
"type": "blockchain",
"message": "The Bitcoin blockchain's Difficulty went above 13,798,783,827,516.0.",
"blockchain": "BTC",
"metric": "Difficulty",
"direction": "above",
"threshold": "13790000000000.0"
}
BTC Dominance Alert
Example JSON Alert
{
"type": "dominance",
"message": "The level of BTC Dominance went above 50.0%",
"currency": "BTC",
"direction": "above",
"threshold": "50.0"
}
"type": "dominance",
"message": "The level of BTC Dominance went above 50.0%",
"currency": "BTC",
"direction": "above",
"threshold": "50.0"
}
MarketCap Alert
Example JSON Alert
{
"type": "market_cap",
"message": "The Bitcoin MarketCap went above $1,000,000,000.0 USD.",
"currency": "BTC",
"direction": "above",
"threshold": "1000000000.0"
}
"type": "market_cap",
"message": "The Bitcoin MarketCap went above $1,000,000,000.0 USD.",
"currency": "BTC",
"direction": "above",
"threshold": "1000000000.0"
}
ETH Gas Price Alert
Example JSON Alert
{
"type": "ethereum_gas_price",
"message": "The cost of a slow Ethereum transaction went below 30 gwei.",
"blockchain": "ETH",
"transaction_speed": "slow",
"direction": "below",
"threshold": "30"
}
"type": "ethereum_gas_price",
"message": "The cost of a slow Ethereum transaction went below 30 gwei.",
"blockchain": "ETH",
"transaction_speed": "slow",
"direction": "below",
"threshold": "30"
}
Volume Alert
Example JSON Alert
{
"type": "volume",
"message": "The trading volume of Ethereum (ETH) has increased by >2x in the last 5 minutes on Binance.",
"currency": "ETH",
"direction": "up",
"multiplier": 2,
"window": 5,
"exchange": "Binance",
}
"type": "volume",
"message": "The trading volume of Ethereum (ETH) has increased by >2x in the last 5 minutes on Binance.",
"currency": "ETH",
"direction": "up",
"multiplier": 2,
"window": 5,
"exchange": "Binance",
}
Whale Alert
Example JSON Alert
{
"type": "whale",
"message": "26,127,990 USDC was transferred from 0xa69babef1ca67a37ffaf7a485dfff3382056e78c to 0x6c0a68b655a58ac43be789d90910ed57af418821.",
"blockchain": "ETH",
"currency": "USDC",
"value": "26,120,151.82",
"target_currency": "USD",
"target_value": "26,127,990.21307",
"from": "0xa69babef1ca67a37ffaf7a485dfff3382056e78c",
"to": "0x6c0a68b655a58ac43be789d90910ed57af418821",
}
"type": "whale",
"message": "26,127,990 USDC was transferred from 0xa69babef1ca67a37ffaf7a485dfff3382056e78c to 0x6c0a68b655a58ac43be789d90910ed57af418821.",
"blockchain": "ETH",
"currency": "USDC",
"value": "26,120,151.82",
"target_currency": "USD",
"target_value": "26,127,990.21307",
"from": "0xa69babef1ca67a37ffaf7a485dfff3382056e78c",
"to": "0x6c0a68b655a58ac43be789d90910ed57af418821",
}
Minimum Balance Alert
Example JSON Alert
{
"type": "minimum_balance",
"message": "The wallet KuCoin (33j8t1YW) went below 10000.0 BTC.",
"currency": "BTC",
"wallet": "33j8t1YWDFDVkzjkiSVAVy6Z7vNhM5EULo",
"direction": "below",
"threshold": "10000.0"
}
"type": "minimum_balance",
"message": "The wallet KuCoin (33j8t1YW) went below 10000.0 BTC.",
"currency": "BTC",
"wallet": "33j8t1YWDFDVkzjkiSVAVy6Z7vNhM5EULo",
"direction": "below",
"threshold": "10000.0"
}
Stock Market Alert
Example JSON Alert
{
"type": "stock_price",
"message": "Apple Inc (AAPL) went above 100.00 USD.",
"stock": "AAPL",
"currency": "USD",
"direction": "above",
"price": "100.0"
}
"type": "stock_price",
"message": "Apple Inc (AAPL) went above 100.00 USD.",
"stock": "AAPL",
"currency": "USD",
"direction": "above",
"price": "100.0"
}
Stock Market Volatility Alert
Example JSON Alert
{
"type": "stock_percent_price",
"message": "Apple Inc (AAPL) changed by -0.03 percent (to 158.56 USD) in the last 5 minutes.",
"direction": "changes",
"percent": "-0.03",
"window": 5,
}
"type": "stock_percent_price",
"message": "Apple Inc (AAPL) changed by -0.03 percent (to 158.56 USD) in the last 5 minutes.",
"direction": "changes",
"percent": "-0.03",
"window": 5,
}
Periodic Stock Price Alert
Example JSON Alert
{
"type": "stock_periodic_price",
"message": "The price of Apple Inc (AAPL) is 161.14 USD.",
"stock": "AAPL",
"currency": "USD",
"price": "161.14"
}
"type": "stock_periodic_price",
"message": "The price of Apple Inc (AAPL) is 161.14 USD.",
"stock": "AAPL",
"currency": "USD",
"price": "161.14"
}
Have a question?