API Reference

Send webhook requests

The structure of a Send webhook request contains several fields that provide information about the transaction.

Identification

You can identify a webhook request using the parameters–type, coin/token. These parameters are described as follows:

  • type: This is the name of the event. For example, "Send".
  • coin: This is the type of native coin transaction. This field isn’t populated if this event is of a token transaction, such as ERC20 assets like USDT. An example of coin is "eth".
  • token: This is the name of the token involved in the transaction. If coins are involved in the transaction, then this field isn’t populated. This field isn’t populated if the event is of a native coin transaction, such as "eth". An example of token is "UNI".

Note: In a webhook response, when tokens are transmitted, the parameter tokenContractAddress is populated.

The following is a sample payload of the "Send" webhook request.

{
  "id": 1917889,
  "txid": "936ad03ff2229b16f6689dfdcdd9e6327f9a8ea7be0bfb95cce51ff13e486584",
  "raw": null,
  "walletid": 2570,
  "type": "send",
  "fee": "0.00000000",
  "effectivechange": "7.00000000",
  "runningbalance": null,
  "timestamp": "2023-09-12T13:47:04.000Z",
  "externaladdress": "TKsWjWy7bsaZhsqMcLKY3N3hP1koBmgsGd",
  "coin": "TRX",
  "effectivechangeusd": "0.55391",
  "wallet": {
    "id": 2570,
    "name": "Sample deposit",
    "type": "pipeline",
    "config": "2of2",
    "balance": "27.00000000",
    "address": "TYDmpfsPdtEwdsMgnqRiy36WTDovZfcJjx",
    "coin": "TRX",
    "chain": "TRON",
    "parentchain": "TRON",
    "subtype": "deposit",
    "isArchived": 0,
    "orgid": 854,
    "balanceUSD": "2.13649785",
    "orgWebhook": "https://api-qa.bitdelta.com/api/v1/hooks/lml-hook"
  },
  "tokenContractAddress": "",
  "sequenceId": "",
  "explorerLink": "https://tronscan.org/#/transaction/936ad03ff2229b16f6689dfdcdd9e6327f9a8ea7be0bfb95cce51ff13e486584",
  "inputs": [
    {
      "address": "TKsWjWy7bsaZhsqMcLKY3N3hP1koBmgsGd",
      "amount": "0.00000000",
      "isMine": false
    }
  ],
  "outputs": [
    {
      "address": "TBfsbAHE9CVL8XiNwL9w2R14RjivoFudGo",
      "amount": "7.00000000",
      "isMine": true,
      "wallet": {
        "id": 2570,
        "name": "Bitdelta Deposit TRON",
        "type": "pipeline",
        "config": "2of2",
        "status": 1,
        "balance": "27.00000000",
        "balanceusd": "2.13649785",
        "raw": null,
        "issynced": true,
        "walletpath": null,
        "walletidentifier": "TYDmpfsPdtEwdsMgnqRiy36WTDovZfcJjx",
        "coin": "TRX",
        "chain": "TRON",
        "parentchain": "TRON",
        "subtype": "deposit",
        "isArchived": false,
        "teamId": null,
        "version": 1,
        "orgid": 854
      }
    }
  ]
}

ObjectParameterData TypeDescriptionExample Value
idIntegerThe unique identifier of the event.1965382
txidStringThe unique identifier of the transaction.0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8
rawStringStores memo for the supported chains, else nullnull
walletIdint32The unique identifier of the wallet.2876
typeStringThe type of "send" or "receive" transaction. If its value is “internal”, ignore it, as it is an internally occurring webhook.send
feeStringThe fee associated with the transaction.0.00824932
effectivechangedecimal(28,8)The number of coins or tokens.4.00000000
runningbalanceStringThe real-time updated total funds change after each transaction.null
timestampStringThe date and time when the transaction was initiated.2023-10-05T07:20:29.000Z
externaladdressStringFor "receive" transaction, this represents the source address.
For "send" transaction, this represents the target address.		0x505e71695e9bc45943c58adec1650577bca68fd9
coinStringType of cryptocurrency involved in the transactionUSDT
effectivechangeusddecimal(18,5)The amount in the USD.4.00000
walletidint32The unique identifier of the wallet.2876
walletnameStringThe name of the wallet.Lightning Nodes Deposit POLYGON
wallettypeStringThe type of wallet.pipeline
walletconfigStringThe minimum required signer configuration of the wallet.2of2
walletbalancedecimal(28,8)The total balance of the wallet.0.00000000
walletaddressStringThe unique address of the wallet.0x6d3E8E04f8F178eF755627546aA84Fca4397B20b
walletcoinStringThe native coin of the wallet chain.MATIC
walletchainStringThe blockchain network of the wallet.POLYGON
walletparentchainStringThe parent blockchain network of the chain where the wallet operates.EVM
walletsubtypeStringThe sub type of the wallet from where the transaction is initiated.deposit
walletisArchivedBooleanThis indicates whether the wallet is archived or not. "1" refers to true, whereas, "0" refers to false.0
walletorgidIntegerThe unique identifier of the organisation.864
walletbalanceUSDdecimal(18,8)The total balance of the wallet in USD.0.00000000
walletorgWebhookStringThe webhook URL setup on the client side.https://testnet-api.pi42.exchange/v1/liminal/webhook
tokenContractAddressStringThe contract address of the token for which the transaction takes place.0xc2132D05D31c914a87C6611C10748AEb04B58e8F
sequenceIdStringThe unique identifier of the transaction sequence. Sequence ID is associated with a send transaction.93544241-c00e-c754-3bd0-494567a67ee8
explorerLinkStringThe URL of a web-based tool that allows users to view and search blockchain transactions, blocks, addresses, and other relevant information.https://polygonscan.com/tx/0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8
inputsaddressStringThe wallet address from where the transaction is initiated.0x505e71695e9bc45943c58adec1650577bca68fd9
inputsamountIntegerThe total amount of the transaction.0.00000000
inputsisMineBooleanThis indicates whether the source address belongs to the transaction initiator or not.true
outputsaddressStringThe wallet address where the transaction is received.0x1963159d1f64538b5dc105d4498d248d615ae57c
outputsamountIntegerThe amount of cryptocurrency received in the destination address.4.00000000
outputsisMineBooleanThis indicates whether the destination address belongs to the transaction initiator or not.true
outputs > walletidint32The unique identifier of the destination wallet.2876
outputs > walletnameStringThe name of the destination wallet.Lightning Nodes Deposit POLYGON
outputs > wallettypeStringThe type of the destination wallet.pipeline
outputs > walletconfigStringThe minimum required signer configuration of the destination wallet.2of2
outputs > walletstatusStringThe current status of the wallet. The value "1" represents active, "0" represents inactive, and "-1" represents the pending status.1
outputs > walletbalancedecimal(28,8)The total balance of the destination wallet.0.00000000
outputs > walletbalanceusdStringThe total balance of the wallet in USD.2.13649785
outputs > walletrawStringThe memo for the supported chains, else null.null
outputs > walletissyncedBooleantrue
outputs > walletwalletpathStringThe path number of the wallet.null
outputs > walletwalletidentifierStringThe unique identifier of the wallet in blockchain.TYDmpfsPdtEwdsMgnqRiy36WTDovZfcJjx
outputs > walletcoinStringThe type of cryptocurrency held in the destination wallet.MATIC
outputs > walletchainStringThe type of blockchain network associated with the destination wallet.POLYGON
outputs > walletparentchainStringThe parent blockchain of the chain where the destination wallet operates.EVM
outputs > walletsubtypeStringThe sub type of the destination wallet.deposit
outputs > walletisArchivedBooleanThis indicates whether the destination wallet is archived or not.0
outputs > walletteamIdStringThe unique identifier of the team associated with the wallet.null
outputs > walletversionIntegerThe version of the wallet.1
outputs > walletorgidIntegerThe unique identifier of the organisation.864

You can view webhook status code, request and response body, and other details in the webhook dashboard within Vaults, as shown below. To learn more about webhook dashboard, see View and manage your webhooks.