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"
}
Have a question?
