The structure of the Receive webhook requests 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, "Receive".
- 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
tokenContractAddressis populated.
The following is a sample payload of the "Receive" webhook request.
{
id: 1965382,
txid: '0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8',
raw: null,
walletid: 2876,
type: ‘Receive’,
fee: '0.00824932',
effectivechange: '4.00000000',
runningbalance: null,
timestamp: '2023-10-05T07:20:29.000Z',
externaladdress: '0x505e71695e9bc45943c58adec1650577bca68fd9',
coin: 'USDT',
effectivechangeusd: '4.00000',
wallet: {
id: 2876,
name: 'Lightning Nodes Deposit POLYGON',
type: 'pipeline',
config: '2of2',
balance: '0.00000000',
address: '0x6d3E8E04f8F178eF755627546aA84Fca4397B20b',
coin: 'MATIC',
chain: 'POLYGON',
parentchain: 'EVM',
subtype: 'deposit',
isArchived: 0,
orgid: 864,
balanceUSD: '0.00000000',
orgWebhook: 'https://testnet-api.pi42.exchange/v1/liminal/webhook'
},
tokenContractAddress: '0xc2132D05D31c914a87C6611C10748AEb04B58e8F',
sequenceId: '',
explorerLink: 'https://polygonscan.com/tx/0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8',
inputs: [
{
address: '0x505e71695e9bc45943c58adec1650577bca68fd9',
amount: '0.00000000',
isMine: false
}
],
outputs: [
{
address: '0x1963159d1f64538b5dc105d4498d248d615ae57c',
amount: '4.00000000',
isMine: true,
wallet: {
id: 2876,
name: 'Lightning Nodes Deposit POLYGON',
type: 'pipeline',
config: '2of2',
balance: '0.00000000',
address: '0x6d3E8E04f8F178eF755627546aA84Fca4397B20b',
coin: 'MATIC',
chain: 'POLYGON',
parentchain: 'EVM',
subtype: 'deposit',
isArchived: 0,
orgid: 864,
balanceUSD: '0.00000000',
orgWebhook: 'https://testnet-api.pi42.exchange/v1/liminal/webhook'
}
}
]
"blockConfirmation": 0,
"resData": 1
}
| Object | Parameter | Data Type | Description | Example Value |
|---|---|---|---|---|
| id | Integer | The unique identifier of the event. | 1965382 | |
| txid | String | The unique identifier of the transaction. | 0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8 | |
| raw | String | The memo for the supported chains, else null. | null | |
| walletId | int32 | The unique identifier of the wallet. | 2876 | |
| type | String | The type of "send" or "receive" transaction. If its value is “internal”, ignore it, as it is an internally occurring webhook. | receive | |
| fee | String | The fee associated with the transaction. | 0.00824932 | |
| effectivechange | decimal(28,8) | The number of coins or tokens. | 4.00000000 | |
| runningbalance | String | The real-time updated total funds change after each transaction. | null | |
| timestamp | String | The date and time when the transaction was initiated. | 2023-10-05T07:20:29.000Z | |
| externaladdress | String | For a "receive" transaction, this represents the source address. For a "send" transaction, this represents the target address. | 0x505e71695e9bc45943c58adec1650577bca68fd9 | |
| coin | String | The type of cryptocurrency involved in the transaction. | USDT | |
| effectivechangeusd | decimal(18,5) | The transaction amount in USD. | 4.00000 | |
| wallet | id | int32 | The unique identifier of the wallet. | 2876 |
| wallet | name | String | The name of the wallet. | Lightning Nodes Deposit POLYGON |
| wallet | type | String | The type of wallet. | pipeline |
| wallet | config | String | The minimum required signer configuration of the wallet. | 2of2 |
| wallet | balance | decimal(28,8) | The total balance of the wallet. | 0.00000000 |
| wallet | address | String | The unique address of the wallet. | 0x6d3E8E04f8F178eF755627546aA84Fca4397B20b |
| wallet | coin | String | The native coin of the wallet chain. | MATIC |
| wallet | chain | String | The blockchain network of the wallet. | POLYGON |
| wallet | parentchain | String | The parent blockchain network of the chain where the wallet operates. | EVM |
| wallet | subtype | String | The sub type of the wallet from where the transaction is initiated. | deposit |
| wallet | isArchived | Boolean | This indicates whether the wallet is archived or not. "1" refers to true, whereas, "0" refers to false. | 0 |
| wallet | orgid | Integer | The unique identifier of the organisation. | 864 |
| wallet | balanceUSD | decimal(18,8) | The total balance of the wallet in USD. | 0.00000000 |
| wallet | orgWebhook | String | The webhook URL setup on the client side. | https://testnet-api.pi42.exchange/v1/liminal/webhook |
| tokenContractAddress | String | The contract address of the token for which the transaction has taken place. | 0xc2132D05D31c914a87C6611C10748AEb04B58e8F | |
| sequenceId | String | The unique identifier (ID) of the transaction sequence. A sequence ID is associated with a "send" transaction. | 93544241-c00e-c754-3bd0-494567a67ee8 | |
| explorerLink | String | The URL of a web-based tool that allows to view and search blockchain transactions, blocks, addresses, and other relevant information. | https://polygonscan.com/tx/0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8 | |
| inputs | address | String | The wallet address from where the transaction is initiated. | 0x505e71695e9bc45943c58adec1650577bca68fd9 |
| inputs | amount | Integer | The total amount of the transaction. | 0.00000000 |
| inputs | isMine | Boolean | This indicates whether the source address belongs to the transaction initiator or not. | true |
| outputs | address | String | Wallet address where the transaction is received | 0x1963159d1f64538b5dc105d4498d248d615ae57c |
| outputs | amount | Integer | The mount of cryptocurrency received in the destination address. | 4.00000000 |
| outputs | isMine | Boolean | This indicates whether the destination address belongs to the transaction initiator or not. | true |
| outputs > wallet | id | int32 | The unique identifier of the destination wallet. | 2876 |
| outputs > wallet | name | String | The name of the destination wallet. | Lightning Nodes Deposit POLYGON |
| outputs > wallet | type | String | The type of the destination wallet. | pipeline |
| outputs > wallet | config | String | The minimum required signer configuration of the destination wallet. | 2of2 |
| outputs > wallet | balance | decimal(28,8) | The total balance of the destination wallet. | 0.00000000 |
| outputs > wallet | address | String | The blockchain address to which the transaction is sent. | 0x6d3E8E04f8F178eF755627546aA84Fca4397B20b |
| outputs > wallet | coin | String | The type of cryptocurrency held in the destination wallet. | MATIC |
| outputs > wallet | chain | String | The type of blockchain network associated with the wallet. | POLYGON |
| outputs > wallet | parentchain | String | The parent blockchain of the chain where the destination wallet operates. | EVM |
| outputs > wallet | subtype | String | The sub type of the destination wallet. | deposit |
| outputs > wallet | isArchived | Boolean | This indicates whether the destination wallet is archived or not. | 0 |
| outputs > wallet | orgid | Integer | The unique identifier of the exchange organisation. | 864 |
| outputs > wallet | balanceUSD | decimal(18,8) | Total balance of the destination wallet in USD. | 0.00000000 |
| outputs > wallet | orgwebhook | String | The webhook URL setup on the client side. | https://testnet-api.pi42.exchange/v1/liminal/webhook |
| blockConfirmation | Number | The difference between the tip of the chain (latestBlock at the time of processing the transaction) and the blockNumber in which the transaction was included (only applicable to UTXO chains). Its value can either be a number or null. | null | 5 |
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.
