Webhook Reference
JSON reference for Dispatch webhook payloads
When a webhook Patch is fired, Dispatch sends an HTTP POST message to your webhook endpoint URL.
The message (payload) is a JSON object with information about the Trigger event.
Here are the JSON structures for each Trigger type.
{
"details": {
"above_or_below": null,
"address": "0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511",
"block_explorer_address_link": "https://etherscan.io/address/0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511",
"change_amount": "-0.115130931858",
"network": "Ethereum",
"new_balance": "1,210.534698218538",
"patch_name": "Send a JSON payload to a webhook endpoint when ETH balance changes (0xb5d8...F511)",
"previous_balance": "1,210.649829150396",
"threshold_amount": null,
"timestamp": "13 Feb, 2023 6:23 PM +UTC",
"token_name": "Ether",
"token_symbol": "ETH",
"truncated_address": "0xb5d8...F511"
},
"patch": {
"action": {
"deleted_at": null,
"description": "Send a JSON payload to a webhook endpoint",
"icon_url": "https://content.esprezzo.io/dispatch/icons/actions/webhook.svg",
"id": "a422b06d-5904-4d19-95cc-92e8c6f57edd",
"inserted_at": "2022-08-26T15:29:55Z",
"name": "Webhook",
"slug": "webhook",
"updated_at": "2022-08-26T15:29:55Z"
},
"action_count": 14,
"deleted_at": null,
"error_count": 0,
"id": "7bb1c092-a68a-42a0-b147-63ea9e1dc277",
"inserted_at": "2023-02-02T19:49:54Z",
"is_active": true,
"name": "Send a JSON payload to a webhook endpoint when ETH balance changes (0xb5d8...F511)",
"settings": [
{
"id": "d4da2972-4ba4-4461-a248-90a0ac4f6fc5",
"inserted_at": "2023-02-02T19:49:54Z",
"integration_channel_id": null,
"integration_id": null,
"patch_id": "7bb1c092-a68a-42a0-b147-63ea9e1dc277",
"setting": {
"description": "A comma-separated list of account addresses to listen to in order to receive account balance changes.",
"id": "cd1aac20-e2d1-4a23-baf6-0da78635e2bc",
"inserted_at": "2022-07-11T14:05:18Z",
"slug": "address-list",
"type": "trigger",
"updated_at": "2022-07-11T14:05:18Z"
},
"setting_id": "cd1aac20-e2d1-4a23-baf6-0da78635e2bc",
"updated_at": "2023-02-02T19:49:54Z",
"value": "0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511"
},
{
"id": "447c827e-68b9-4f0a-a662-1fbab0a2a899",
"inserted_at": "2023-02-02T19:49:54Z",
"integration_channel_id": "https://webhook.site/842f0c2a-6749-432c-ac8f-d24366059ed9",
"integration_id": "217a5e9f-1405-4a6b-ac0a-fbf0c0c4c7e0",
"patch_id": "7bb1c092-a68a-42a0-b147-63ea9e1dc277",
"setting": {
"description": "The channel to dispatch Telegram messages to.",
"id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"inserted_at": "2022-07-11T14:05:16Z",
"slug": "integration",
"type": "action",
"updated_at": "2022-07-11T14:05:16Z"
},
"setting_id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"updated_at": "2023-02-02T19:49:54Z",
"value": "My Cool webhook"
}
],
"trigger": {
"deleted_at": null,
"description": "When the balance of a specific asset in a wallet or smart contract changes",
"icon_url": "https://content.esprezzo.io/dispatch/icons/triggers/address-balance-change.svg",
"id": "a858081d-9f46-46f4-8617-e27f6ae1a123",
"inserted_at": "2022-07-11T14:05:17Z",
"name": "Address balance change",
"slug": "address-balance-change",
"type": "balance-change",
"updated_at": "2022-07-11T14:05:17Z"
},
"updated_at": "2023-02-13T18:17:26Z"
}
}
{
"details": {
"above_or_below": "below",
"address": "0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511",
"block_explorer_address_link": "https://etherscan.io/address/0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511",
"change_amount": "-2.250671200561",
"network": "Ethereum",
"new_balance": "1,188.834730915411",
"patch_name": "Send a JSON payload to a webhook endpoint when ETH balance < 1,191 (0xb5d8...F511)",
"previous_balance": "1,191.085402115972",
"threshold_amount": "1,191.00",
"timestamp": "13 Feb, 2023 7:55 PM +UTC",
"token_name": "Ether",
"token_symbol": "ETH",
"truncated_address": "0xb5d8...F511"
},
"patch": {
"action": {
"deleted_at": null,
"description": "Send a JSON payload to a webhook endpoint",
"icon_url": "https://content.esprezzo.io/dispatch/icons/actions/webhook.svg",
"id": "a422b06d-5904-4d19-95cc-92e8c6f57edd",
"inserted_at": "2022-08-26T15:29:55Z",
"name": "Webhook",
"slug": "webhook",
"updated_at": "2022-08-26T15:29:55Z"
},
"action_count": 0,
"deleted_at": null,
"error_count": 0,
"id": "687a6c3e-7de4-45a5-a221-38f292e0c066",
"inserted_at": "2023-02-13T19:41:01Z",
"is_active": true,
"name": "Send a JSON payload to a webhook endpoint when ETH balance < 1,191 (0xb5d8...F511)",
"settings": [
{
"id": "550e208d-6a75-4a83-8f72-287fea0b9742",
"inserted_at": "2023-02-13T19:41:01Z",
"integration_channel_id": "https://webhook.site/842f0c2a-6749-432c-ac8f-d24366059ed9",
"integration_id": "217a5e9f-1405-4a6b-ac0a-fbf0c0c4c7e0",
"patch_id": "687a6c3e-7de4-45a5-a221-38f292e0c066",
"setting": {
"description": "The channel to dispatch Telegram messages to.",
"id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"inserted_at": "2022-07-11T14:05:16Z",
"slug": "integration",
"type": "action",
"updated_at": "2022-07-11T14:05:16Z"
},
"setting_id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"updated_at": "2023-02-13T19:41:01Z",
"value": "My Cool Webhook"
},
{
"id": "799766da-0170-424a-a20e-653d95894875",
"inserted_at": "2023-02-13T19:41:01Z",
"integration_channel_id": null,
"integration_id": null,
"patch_id": "687a6c3e-7de4-45a5-a221-38f292e0c066",
"setting": {
"description": "A lower limit for when the comparison of the previous and new balance crosses this threshold.",
"id": "d8e48b57-5d44-4b9a-8851-18ac78748d72",
"inserted_at": "2022-07-11T14:05:18Z",
"slug": "below-threshold",
"type": "trigger",
"updated_at": "2022-07-11T14:05:18Z"
},
"setting_id": "d8e48b57-5d44-4b9a-8851-18ac78748d72",
"updated_at": "2023-02-13T19:41:01Z",
"value": "1191"
},
{
"id": "e264e7d7-d292-4518-840e-227ef3d21a1a",
"inserted_at": "2023-02-13T19:41:01Z",
"integration_channel_id": null,
"integration_id": null,
"patch_id": "687a6c3e-7de4-45a5-a221-38f292e0c066",
"setting": {
"description": "A comma-separated list of account addresses to listen to in order to receive account balance changes.",
"id": "cd1aac20-e2d1-4a23-baf6-0da78635e2bc",
"inserted_at": "2022-07-11T14:05:18Z",
"slug": "address-list",
"type": "trigger",
"updated_at": "2022-07-11T14:05:18Z"
},
"setting_id": "cd1aac20-e2d1-4a23-baf6-0da78635e2bc",
"updated_at": "2023-02-13T19:41:01Z",
"value": "0xb5d85CBf7cB3EE0D56b3bB207D5Fc4B82f43F511"
}
],
"trigger": {
"deleted_at": null,
"description": "When the balance of an token goes above or below a threshold for one address",
"icon_url": "https://content.esprezzo.io/dispatch/icons/triggers/balance-threshold-reached.svg",
"id": "c17e8157-3125-4b68-99d4-c3df6b18cf61",
"inserted_at": "2022-07-11T14:05:17Z",
"name": "Balance threshold reached",
"slug": "balance-threshold-reached",
"type": "balance-change",
"updated_at": "2022-07-11T14:05:17Z"
},
"updated_at": "2023-02-13T19:41:01Z"
}
}
This applies to Uniswap v2 DEXs and its clones (SushiSwap, QuickSwap, etc.)
{
"details": {
"token_2_decimals": 18,
"token_1_decimals": 18,
"token_2_name": "Wrapped Ether",
"token_1_reserve_amount": "1,000,000,000.000000",
"dex_pair_term": "pair",
"dex_pair_info_link": "https://v2.info.uniswap.org/pair/0xD15084b6Dfc715c45c48cb4f0Feca26020aF5AA4",
"dex_factory_address": "0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f",
"block_explorer_token_2_token_link": "https://etherscan.io/token/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"token_2_reserve_amount": "3.000000",
"pair_contract_address": "0xD15084b6Dfc715c45c48cb4f0Feca26020aF5AA4",
"dex_emoji": "🦄",
"timestamp": "13 Feb, 2023 8:28 PM +UTC",
"dex_token_2_info_link": "https://v2.info.uniswap.org/token/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"block_explorer_token_2_contract_link": "https://etherscan.io/address/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
"token_1_symbol": "AMOR ",
"tx_hash": "0x5c028e09625ca0b62c9655f929a1fd48a4aa84f0d8b737dd035d3a14fe556ab3",
"block_explorer_tx_link": "https://etherscan.io/tx/0x5c028e09625ca0b62c9655f929a1fd48a4aa84f0d8b737dd035d3a14fe556ab3",
"block_explorer_token_1_token_link": "https://etherscan.io/token/0xb412273006f210A84A0d4F519F07E92492119477",
"token_2_symbol": "WETH",
"dex_name": "Uniswap V2",
"block_explorer_name": "Etherscan",
"token_1_contract_address": "0xb412273006f210A84A0d4F519F07E92492119477",
"block_number": 16622219,
"dex_token_1_info_link": "https://v2.info.uniswap.org/token/0xb412273006f210A84A0d4F519F07E92492119477",
"patch_name": "Send a JSON payload to a webhook endpoint when a new pair is added on Uniswap V2 DEX",
"dex_factory_pair_number": 145773,
"token_1_name": "AI Matchmaking Operative Research ",
"block_explorer_block_link": "https://etherscan.io/block/16622219",
"network": "Ethereum",
"block_explorer_liquidity_pair_link": "https://etherscan.io/address/0xD15084b6Dfc715c45c48cb4f0Feca26020aF5AA4",
"block_explorer_token_1_contract_link": "https://etherscan.io/address/0xb412273006f210A84A0d4F519F07E92492119477",
"dex_tools_pair_explorer_link": "https://www.dextools.io/app/en/ether/pair-explorer/0xD15084b6Dfc715c45c48cb4f0Feca26020aF5AA4",
"token_2_contract_address": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
},
"patch": {
"action": {
"deleted_at": null,
"description": "Send a JSON payload to a webhook endpoint",
"icon_url": "https://content.esprezzo.io/dispatch/icons/actions/webhook.svg",
"id": "a422b06d-5904-4d19-95cc-92e8c6f57edd",
"inserted_at": "2022-08-26T15:29:55Z",
"name": "Webhook",
"slug": "webhook",
"updated_at": "2022-08-26T15:29:55Z"
},
"action_count": 0,
"deleted_at": null,
"error_count": 0,
"id": "5c3d345b-8cb2-4fab-9c33-6e7193c8eef6",
"inserted_at": "2023-02-02T19:50:28Z",
"is_active": true,
"name": "Send a JSON payload to a webhook endpoint when a new pair is added on Uniswap V2 DEX",
"settings": [
{
"id": "8bc17210-4978-4549-ab46-d712706f06a3",
"inserted_at": "2023-02-02T19:50:28Z",
"integration_channel_id": "https://webhook.site/842f0c2a-6749-432c-ac8f-d24366059ed9",
"integration_id": "217a5e9f-1405-4a6b-ac0a-fbf0c0c4c7e0",
"patch_id": "5c3d345b-8cb2-4fab-9c33-6e7193c8eef6",
"setting": {
"description": "The channel to dispatch Telegram messages to.",
"id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"inserted_at": "2022-07-11T14:05:16Z",
"slug": "integration",
"type": "action",
"updated_at": "2022-07-11T14:05:16Z"
},
"setting_id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"updated_at": "2023-02-02T19:50:28Z",
"value": "My Cool Webhook"
}
],
"trigger": {
"deleted_at": null,
"description": "When a new trading pair is added on Uniswap V2 DEX",
"icon_url": "https://content.esprezzo.io/dispatch/icons/triggers/new-uniswap-v2-pair-listing.svg",
"id": "03e7d1b0-b556-4006-9035-702ffe8ac13e",
"inserted_at": "2022-07-11T14:05:17Z",
"name": "New Uniswap v2 pair listing",
"slug": "new-uniswap-v2-pair-listing",
"type": "v2-dex",
"updated_at": "2022-07-11T14:05:17Z"
},
"updated_at": "2023-02-02T19:50:28Z"
}
}
{
"details": {
"attributes": [
{
"name": "Background",
"percentage": "1.82%",
"value": "Orange"
},
{
"name": "Mouth",
"percentage": "2.22%",
"value": "Bored Unshaven"
},
{
"name": "Earring",
"percentage": "1.26%",
"value": "Silver Hoop"
},
{
"name": "Clothes",
"percentage": "0.36%",
"value": "Sleeveless T"
},
{
"name": "Fur",
"percentage": "0.73%",
"value": "Pink"
},
{
"name": "Eyes",
"percentage": "0.5%",
"value": "Sunglasses"
}
],
"block_explorer_collection_link": "https://etherscan.io/address/0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
"block_explorer_name": "Etherscan",
"block_explorer_token_link": "https://etherscan.io/token/ethereum/0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D/2281",
"block_explorer_tx_link": "https://etherscan.io/tx/0xe700e4e33e6d003f23488f673019a8afb791f73210c07b1f2e3c863c28769fc0",
"block_number": 16621044,
"blßock_explorer_block_link": "https://etherscan.io/block/16621044",
"collection_id": "2a4315e1-825b-412d-84c7-e1eae3aa0fd3",
"collection_name": "Bored Ape Yacht Club",
"from_address": "0x4324343313ee01f6dFC464395d72A65A5c67447C",
"image_url": "https://nftmedia-dev.esprezzo.io/media/ethereum/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/5485.png",
"image_url_thumbnail": "https://nftmedia-dev.esprezzo.io/media/ethereum/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/5485_sm.png",
"network": "Ethereum",
"nft_contract_address": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
"nft_marketplace_collection_link": "https://opensea.io/collection/boredapeyachtclub",
"nft_marketplace_name": "OpenSea",
"nft_marketplace_token_link": "https://opensea.io/assets/ethereum/0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D/2281",
"patch_name": "Send a JSON payload to a webhook endpoint when Bored Ape Yacht Club NFTs are transferred",
"rarity_label": "Common",
"rarity_rank": 8672,
"rarity_rank_max": 10000,
"rarity_score": "132.76",
"rarity_score_normalized": "7.94",
"skip_rarity": false,
"timestamp": "13 Feb, 2023 4:31 PM +UTC",
"to_address": "0xDAFCe4AcC2703A24F29d1321AdAADF5768F54642",
"token_id": 2281,
"token_name": "BoredApeYachtClub #2281",
"tx_hash": "0xe700e4e33e6d003f23488f673019a8afb791f73210c07b1f2e3c863c28769fc0"
},
"patch": {
"action": {
"deleted_at": null,
"description": "Send a JSON payload to a webhook endpoint",
"icon_url": "https://content.esprezzo.io/dispatch/icons/actions/webhook.svg",
"id": "a422b06d-5904-4d19-95cc-92e8c6f57edd",
"inserted_at": "2022-08-26T15:29:55Z",
"name": "Webhook",
"slug": "webhook",
"updated_at": "2022-08-26T15:29:55Z"
},
"action_count": 2934,
"deleted_at": null,
"error_count": 3,
"id": "51ed88b8-3a44-4a29-bd5d-e0d3cc95d216",
"inserted_at": "2023-02-02T19:51:01Z",
"is_active": true,
"name": "Send a JSON payload to a webhook endpoint when Bored Ape Yacht Club NFTs are transferred",
"settings": [
{
"id": "56ff1425-63d3-4958-95df-af6730e208ae",
"inserted_at": "2023-02-02T19:51:01Z",
"integration_channel_id": "https://webhook.site/842f0c2a-6749-432c-ac8f-d24366059ed9",
"integration_id": "217a5e9f-1405-4a6b-ac0a-fbf0c0c4c7e0",
"patch_id": "51ed88b8-3a44-4a29-bd5d-e0d3cc95d216",
"setting": {
"description": "The channel to dispatch Telegram messages to.",
"id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"inserted_at": "2022-07-11T14:05:16Z",
"slug": "integration",
"type": "action",
"updated_at": "2022-07-11T14:05:16Z"
},
"setting_id": "8d7dfc6d-b443-4860-8a06-5c534935d289",
"updated_at": "2023-02-02T19:51:01Z",
"value": "My Cool Webhook"
}
],
"trigger": {
"deleted_at": null,
"description": "When any NFTs from a specific collection are moved",
"icon_url": "https://content.esprezzo.io/dispatch/icons/triggers/nft-collection-items-transferred.svg",
"id": "29e05c35-fd09-475b-9291-37caba759270",
"inserted_at": "2022-08-11T16:17:39Z",
"name": "NFT collection items transferred",
"slug": "nft-collection-items-transferred",
"type": "nft",
"updated_at": "2022-08-11T16:17:39Z"
},
"updated_at": "2023-02-02T19:51:01Z"
}
}
Last modified 1mo ago