Blockchain event detected

A wallet event has been confirmed on chain (e.g.: a deposit). The blockchainEvent.kind field identifies the type of asset transfer and varies by network and asset (for example NativeTransfer, Erc20Transfer, UtxoTransfer, SplTransfer, Trc20Transfer); see the full list of event kinds per chain in the webhook events reference. The confirmation delay per network is listed here.

WEBHOOK wallet.blockchainevent.detected

Example

{
  "id": "whe-544ul-uqgad-jkgltj5p6fvd04cj",
  "date": "2023-04-14T20:41:28.715Z",
  "timestampSent": 1719566994,
  "deliveryAttempt": 1,
  "kind": "wallet.blockchainevent.detected",
  "data": {
    "blockchainEvent": {
      "kind": "Erc20Transfer",
      "walletId": "wa-1f04s-lqc9q-xxxxxxxxxxxxxxxx",
      "network": "Ethereum",
      "direction": "Out",
      "blockNumber": 19036906,
      "timestamp": "2024-01-18T23:03:59.000Z",
      "status": "Confirmed",
      "txHash": "0x8e88793607610a83798eb5ec6dde861f3e459c7e4a22e78b0d2e675b86d0d1e7",
      "index": "134",
      "from": "0xea09cf8a006493566f8a8fd3d0b32ebff5939d6a",
      "to": "0xc42754e6f79f15082613b2b4ebead83dcf8116b6",
      "value": "1000000",
      "decimals": 6,
      "fee": "1542993669053672",
      "metadata": {
        "asset": {
          "symbol": "USDC",
          "decimals": 6,
          "verified": true
        },
        "fee": {
          "symbol": "ETH",
          "decimals": 18,
          "verified": true
        }
      }
    },
    "wallet": {
      "id": "wa-1f04s-lqc9q-xxxxxxxxxxxxxxxx",
      "network": "Ethereum",
      "address": "0x00e3495cf6af59008f22ffaf32d4c92ac33dac47",
      "name": "trading hot wallet",
      "signingKey": {
        "id": "key-6ece3-9l565-xxxxxxxxxxxxxxxx",
        "scheme": "ECDSA",
        "curve": "secp256k1",
        "publicKey": "e2375c8c9e87bfcd0be8f29d76c818cabacd51584f72cb2222d49a13b036d84d3d"
      },
      "status": "Active",
      "dateCreated": "2023-04-14T20:41:28.715Z",
      "custodial": true,
      "tags": []
    }
  },
  "retryOf": "whe-544ul-uqgad-jkgltj5p6fvd04cj"
}

Body

application/json

id · string · required

Unique identifier for this webhook event.

Required string length: 1 - 64

Pattern: ^whe-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"whe-544ul-uqgad-jkgltj5p6fvd04cj"

date · string<date-time> · required

ISO 8601 date (must be UTC). Timestamp when the event occurred.

Example:

"2023-04-14T20:41:28.715Z"

timestampSent · integer · required

Unix timestamp when the event was sent

Example:

1719566994

deliveryAttempt · integer · required

Delivery attempt number

Required range: x >= 1

Example:

1

kind · enum<string> · required

Available options: wallet.blockchainevent.detected

data · object · required

Show child attributes

retryOf · string

ID of the original event if this is a retry.

Required string length: 1 - 64

Pattern: ^whe-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"whe-544ul-uqgad-jkgltj5p6fvd04cj"

Response

200

Respond with a 200 to indicate that the event was successfully received. If your endpoint returns anything else than a 200 status code, we will consider the delivery has failed and retry later. See details here.