Guides

Webhook Events

Webhook notifications sent on wallet creation, deposit and withdrawal events

Suggest Edits

Wallet webhook events are fired based on wallet creation, deposit and withdrawal transaction activities.

Wallet Creation

Creation Event

This is the wallet creation event that will trigger a webhook notification.

WALLET_CREATED

Creation Webhook Structure

This is the general structure of the creation webhooks regardless of the event.

{
  event: 'WALLET_CREATED',
  message: 'A new lending wallet was created',
  data: {
    walletId: 'f92f8575-7e38-5780-b3f6-85f7a2af8240',
    currency: 'USDT',
    addresses: [ 
      {
         "address": "0x6e8A8d0f72C6c5Ea699B59b6f8c597d67C459349",
         "network": "bep20"
  		}
    ],
    addressType: 'lending',
    integratorPk: '878cc71f-4002-42d5-8854-b7523c9fc6cb'
  }
}

{
  	"x-oneliquidity-signature": "a18dff22eadc597bfeda1e2edc189e40caeee6ae292ec1893c35703a3413dab3",
}

Deposits

Deposit Events

These are the wallet deposit events that will trigger a webhook notification.

WALLET_DEPOSIT_INITIATED
WALLET_DEPOSIT_COMPLETED

Deposit Webhook Structure

This is the general structure of the deposit webhooks regardless of the event. 

{
  "event": "WALLET_DEPOSIT_INITIATED",
  "message": "A wallet deposit was initiated",
  "data": {
    "currency": "ETH",
    "txid": "0x442fb1814d30b0b9a65fa650c1a59ead2d9f3ab3578fc138019b79a3d38e1dcc",
    "amount": "2000000000000000",
    "fees": "31500000210000",
    "from_address": "0x1086957eA2aE8D4d4D425D24527f503D04848e46",
    "to_address": "0xBBF7AaDE38d8da6aF72877325AA1D46866614853",
    "decimal": 18,
    "processing_state": 1
  },
}

{
  	"x-oneliquidity-signature": "a18dff22eadc597bfeda1e2edc189e40caeee6ae292ec1893c35703a3413dab3",
}

For the mock deposits, you can expect the webhook notification in this way.

{
  "event": "WALLET_DEPOSIT_COMPLETED",
  "message": "A wallet deposit was completed",
  "data": {
    "currency": "USDT",
    "txid": "mock_transaction",
    "amount": "100000000",
    "fees": "mock_transaction",
    "from_address": "mock_transaction",
    "to_address": "0x64c861A819773F51A4d0735cdfef8A0B4e1e08EA",
    "decimal": "mock_transaction",
    "processing_state": "mock_transaction"
  },
}

{
  	"x-oneliquidity-signature": "a18dff22eadc597bfeda1e2edc189e40caeee6ae292ec1893c35703a3413dab3",
}

Withdrawals

Withdrawal Events

These are the wallet withdrawal events that will trigger a webhook notification.

WALLET_WITHDRAWAL_PROCESSING
WALLET_WITHDRAWAL_FAILURE
WALLET_WITHDRAWAL_COMPLETED
WALLET_WITHDRAWAL_REJECTED
WALLET_WITHDRAWAL_CANCELLED
WALLET_WITHDRAWAL_REFUNDED

Withdrawal Webhook Structure

This is the general structure of the withdrawal webhooks regardless of the event.

{
  "event": "WALLET_WITHDRAWAL_COMPLETED",
  "message": "A wallet withdrawal is completed",
  "data": {
    "withdrawalId": "fe2ad154-1880-5942-85c1-8f80519e1347",
    "currency": "USDT",
    "amount": 5,
    "from_address": "0x64c861A819773F51A4d0735cdfef8A0B4e1e08EA",
    "to_address": "0x64c861A819773F51A4d0735cdfef8A0B4e1e08EA"
  },
}

{
  	"x-oneliquidity-signature": "a18dff22eadc597bfeda1e2edc189e40caeee6ae292ec1893c35703a3413dab3",
}

📘

Webhook URL

Please update your webhook url if you are not receiving webhooks using this API route.

Updated 10 months ago