GitHubDiscord

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.

Smart Contract Activity Trigger

Aka "Event monitor" — a trigger that fires when your selected smart contract events are emitted or functions are called.

{
  "details": {
    "block_explorer_block_link": "https://etherscan.io/block/18479837",
    "block_explorer_contract_link": "https://etherscan.io/address/0xd774557b647330C91Bf44cfEAB205095f7E6c367",
    "block_explorer_name": "Etherscan",
    "block_explorer_tx_link": "https://etherscan.io/tx/0x4aea2871a593877974eeff77529b937666d7410a118cbf1a2dd41042e613c01d",
    "block_number": 18479837,
    "contract_address": "0xd774557b647330C91Bf44cfEAB205095f7E6c367",
    "contract_name": "Nakamigos",
    "network": "Ethereum",
    "patch_event_id": "772977e6-f3d0-4916-bb78-6bc4460ee880",
    "patch_event_link": "https://dispatch.esprezzo.io/patches/history/772977e6-f3d0-4916-bb78-6bc4460ee880",
    "patch_id": "22594135-b546-415c-bce4-c43c370e4f0c",
    "patch_name": "Send a JSON payload to a webhook endpoint when Transfer event is emitted by Nakamigos",
    "signature": "Transfer(address,address,uint256)",
    "signature_display": "Transfer(address indexed from, address indexed to, uint256 indexed tokenId)",
    "signature_name": "Transfer",
    "signature_type": "event",
    "timestamp": "1 Nov, 2023 9:07 PM +UTC",
    "tx_hash": "0x4aea2871a593877974eeff77529b937666d7410a118cbf1a2dd41042e613c01d",
    "username": "test1",
    "values": [
      {
        "name": "from",
        "type": "address",
        "value": "0xd8Ac2855F5079671d4C0970c6FA16531eeA3907c"
      },
      {
        "name": "to",
        "type": "address",
        "value": "0x9698024d6Be6807482ec5d582CD73D2f469F5b5C"
      },
      {
        "name": "tokenid",
        "type": "uint",
        "value": "19397"
      }
    ]
  },
  "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": "22594135-b546-415c-bce4-c43c370e4f0c",
    "inserted_at": "2023-11-01T20:32:20Z",
    "is_active": true,
    "name": "Send a JSON payload to a webhook endpoint when Transfer event is emitted by Nakamigos",
    "settings": [
      {
        "id": "41caa2ec-35dc-4aa7-8e13-4eac57d6bd60",
        "inserted_at": "2023-11-01T20:32:20Z",
        "integration_channel_id": null,
        "integration_id": null,
        "patch_id": "22594135-b546-415c-bce4-c43c370e4f0c",
        "setting": {
          "description": "A comma-separated list of implementation event signatures to listen to in order to receive smart contract events.",
          "id": "a2a32f3a-06c0-4f20-8842-d85cd2192c59",
          "inserted_at": "2023-04-04T14:14:03Z",
          "slug": "implementation-event-list",
          "type": "trigger",
          "updated_at": "2023-04-04T14:14:03Z"
        },
        "setting_id": "a2a32f3a-06c0-4f20-8842-d85cd2192c59",
        "updated_at": "2023-11-01T20:32:20Z",
        "value": "Transfer(address indexed from, address indexed to, uint256 indexed tokenId)"
      },
      {
        "id": "24791c6c-0b93-4a7e-80a7-86d93afdca53",
        "inserted_at": "2023-11-01T20:32:20Z",
        "integration_channel_id": "https://webhook.site/842f0c2a-6749-432c-ac8f-d24366059ed9",
        "integration_id": "217a5e9f-1405-4a6b-ac0a-fbf0c0c4c7e0",
        "patch_id": "22594135-b546-415c-bce4-c43c370e4f0c",
        "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-11-01T20:32:20Z",
        "value": "My Cool Webhook"
      }
    ],
    "trigger": {
      "deleted_at": null,
      "description": "When specific functions are called and/or events are emitted",
      "icon_url": "https://content.esprezzo.io/dispatch/icons/triggers/smart-contract-activity.svg",
      "id": "588cbfa7-24fa-4aa7-8e0e-73830b4443b6",
      "inserted_at": "2023-03-02T18:02:36Z",
      "name": "Smart contract activity",
      "slug": "smart-contract-activity",
      "type": "user-contract",
      "updated_at": "2023-03-02T18:02:36Z"
    },
    "updated_at": "2023-11-01T20:32:20Z"
  }
}

Balance Change Trigger

Balance Threshold Reached Trigger

PreviousCreate your first webhookNextHelp Center

Last updated