Receive webhook requests

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 tokenContractAddress is 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'
            }
        }
    ]
}

Object	Parameter	Data type	Description	Example value
	id	Integer	Unique identifier of the event	1965382
	txid	String	Unique identifier of the transaction	0x62eaf9706dac678d8daf672259c44a22e13c7f73b62c6240bd8b5719764d9ae8
	raw	String	Stores memo for the supported chains, else null	null
	walletId	int32	Unique identifier of the wallet	2876
	type	String	This is a type of send or receive transaction. If its value is “internal”, you can ignore it, as it is an internally occurring webhook.	send, receive, internal
	fee	String	Fee associated with the transaction	0.00824932
	effectivechange	decimal(28,8)	Number of coins or tokens	4.00000000
	timestamp	String	Date and time when the transaction was initiated	2023-10-05T07:20:29.000Z
	externaladdress	String	In case of a receive transaction, this represents the source address. In case of a send transaction, this represents the target address.	0x505e71695e9bc45943c58adec1650577bca68fd9
	coin	String	Type of cryptocurrency involved in the transaction	USDT
	effectivechangeusd	decimal(18,5)	Amount in the USD	4.00000
wallet	id	int32	Unique identifier of the wallet	2876
wallet	name	String	Name of the wallet	Lightning Nodes Deposit POLYGON
wallet	type	String	Type of wallet	pipeline
wallet	config	String	Configuration of the wallet	2of2
wallet	balance	decimal(28,8)	Total balance of the wallet	0.00000000
wallet	address	String	Unique address of the wallet	0x6d3E8E04f8F178eF755627546aA84Fca4397B20b
wallet	coin	String	Native coin of the wallet chain	MATIC
wallet	chain	String	Blockchain network of the wallet	POLYGON
wallet	parentchain	String	Parent blockchain network of the chain where the wallet operates	EVM
wallet	subtype	String	Subtype 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	Unique identifier of the exchange organization that was created in Admin Panel	864
wallet	balanceUSD	decimal(18,8)	Total balance of the wallet in USD	0.00000000
wallet	orgWebhook	String	Webhook URL setup on client side	https://testnet-api.pi42.exchange/v1/liminal/webhook
	tokenContractAddress	String	The contract address of the token for which the transaction takes place.	0xc2132D05D31c914a87C6611C10748AEb04B58e8F
	sequenceId	String	This is the unique identifier of the transaction sequence. Sequence ID is associated with a send transaction.	93544241-c00e-c754-3bd0-494567a67ee8
	explorerLink	String	This is a 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
inputs	address	String	Wallet address from where the transaction is initiated	0x505e71695e9bc45943c58adec1650577bca68fd9
inputs	amount	Integer	Total amount of the transaction	0.00000000
inputs	isMine	Boolean	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	amount of cryptocurrency received at the output address	4.00000000
outputs	isMine	Boolean	Indicates whether the destination address belongs to the user or not	true
outputs > wallets	id	int32	Unique identifier of the destination wallet	2876
outputs > wallets	name	String	Name of the destination wallet	Lightning Nodes Deposit POLYGON
outputs > wallets	type	String	Type of the destination wallet	pipeline
outputs > wallets	config	String	Configuration of the destination wallet	2of2
outputs > wallets	balance	decimal(28,8)	Total balance of the destination wallet	0.00000000
outputs > wallets	address	String	Blockchain address to which the transaction is sent	0x6d3E8E04f8F178eF755627546aA84Fca4397B20b
outputs > wallets	coin	String	Type of cryptocurrency held in the destination wallet	MATIC
outputs > wallets	chain	String	Type of blockchain network associated with the wallet	POLYGON
outputs > wallets	parentchain	String	Parent blockchain of the chain where the destination wallet operates	EVM
outputs > wallets	subtype	String	Subtype of the destination wallet	deposit
outputs > wallets	isArchived	Boolean	Indicates whether the destination wallet is archived or not	0
outputs > wallets	orgid	Integer	Unique identifier of the exchange organization which is created in Admin Panel	864
outputs > wallets	balanceUSD	decimal(18,8)	Total balance of the destination wallet in USD	0.00000000
outputs > wallets	orgwebhook	String	Webhook URL setup on client side	https://testnet-api.pi42.exchange/v1/liminal/webhook

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.