Events List Documentation | Webhook Docs

The events you receive depend on the type of transaction:

Bridge and bridge+swap transfers, created with POST /bridge/quote/bridge-swap/user
Smart Deposit Address activity, for addresses created with POST /sda/deposit-addresses

For how webhooks fit with the status and history endpoints, see Track transactions.

Bridge and bridge+swap events

Bridge events have the same data structure as the bridge status endpoint response, without the state field. The _tag field gives the event type, and _id is the transfer’s quote ID.

Event	Sent when
`BRIDGE_PENDING`	The quote is committed
`BRIDGE_ACCEPTED`	The deposit transaction is received and validated
`BRIDGE_EXECUTED`	The transfer is complete and funds are received on the destination chain
`BRIDGE_REFUNDED`	A transfer that includes a swap is refunded, for example because the token price moved too much after the quote
`BRIDGE_CANCELLED`	A committed transfer is cancelled

A cancelled transfer can still go ahead if a matching deposit is detected onchain. In that case, you receive the later bridge events as normal.

Event names and status-endpoint states don’t always match. A refunded swap is BRIDGE_REFUNDED as a webhook event and SWAP_FAILED_REFUNDED as a state. See States.

Smart Deposit Address events

These events are sent for any activity involving a Rhino.fi Smart Deposit Address.

DEPOSIT_ADDRESS_CREATED

Sent when a new Smart Deposit Address is created.

{
  _tag: "DEPOSIT_ADDRESS_CREATED",
  depositChain: string,
  depositAddress: string,
  destinationChain: string,
  destinationAddress: string,
  tokenOut?: string,
  postBridgeData?: PostBridgeData,
  addressNote?: string,
}

BRIDGE_PENDING, BRIDGE_ACCEPTED and BRIDGE_EXECUTED

The same events as for bridge transfers above are sent for each deposit to a Smart Deposit Address. For SDAs, BRIDGE_PENDING is sent when a deposit is detected.

DEPOSIT_ADDRESS_BRIDGE_REJECTED

Sent when a deposit to a Smart Deposit Address is rejected, for example because it is below the minimum amount.

{
  _tag: "DEPOSIT_ADDRESS_BRIDGE_REJECTED",
  _id: string, // bridge ID
  tokenSymbol: string,
  tokenAddress: string,
  amount: string,
  amountUsd: string,
  amountWei: string,
  sender: string, // depositor address
  txHash: string, // deposit transaction hash
  reason: string, // why it was rejected, e.g. "UNDER_MIN"
  createdAt: string,
  depositAddress: { // the deposit address's parameters
    depositChain: string,
    depositAddress: string,
    destinationChain: string,
    destinationAddress: string,
  },
}

DEPOSIT_ADDRESS_BRIDGE_REJECTED - UNSUPPORTED_TOKEN

Sent when a deposit is rejected because Rhino.fi doesn’t support the token that was sent. See Supported chains and tokens for the full list.

Rhino.fi monitors a selection of unsupported tokens on each chain, but not every unsupported token. Some deposits of unsupported tokens may not trigger this event.

The payload is the same as DEPOSIT_ADDRESS_BRIDGE_REJECTED, with this _tag:

{
  _tag: "DEPOSIT_ADDRESS_BRIDGE_REJECTED - UNSUPPORTED_TOKEN",
  // ...same fields as DEPOSIT_ADDRESS_BRIDGE_REJECTED
}

DEPOSIT_ADDRESS_BRIDGE_DELAYED

Sent when a deposit is taking longer than expected to settle, for example because of onchain congestion. The transfer is retried automatically, and no action is needed.

{
  _tag: "DEPOSIT_ADDRESS_BRIDGE_DELAYED",
  _id: string, // bridge ID
  tokenSymbol: string,
  tokenAddress: string,
  amount: string,
  amountUsd: string,
  amountWei: string,
  sender: string, // depositor address
  txHash: string, // deposit transaction hash
  originalErrorTag: string, // why the transfer is delayed
  depositAddress: { // the deposit address's parameters
    depositChain: string,
    depositAddress: string,
    destinationChain: string,
    destinationAddress: string,
  },
}

SDA_REFUND_COMPLETED

Sent when a refund is issued from a Smart Deposit Address.

{
  _tag: "SDA_REFUND_COMPLETED",
  refundId: string,
  depositAddress: string,
  depositChain: string,
  recipient: string, // recipient of the refund
  trigger: {
    _tag: "REJECTED_BRIDGE" | "UNSUPPORTED_TOKEN",
    rejectedDepositAddressBridgeId: string | undefined,
    nativeToken: boolean, // if true, tokenAddress is undefined, as native tokens have no address
    amountWei: string,
    amount: string | undefined, // human-readable refund amount
    amountUsd: string | undefined,
    tokenAddress: string | undefined,
    tokenSymbol: string | undefined,
  },
  originalDepositTxHash: string | undefined, // hash of the refunded deposit
  txHash: string, // hash of the refund transaction
  txTimestamp: string, // timestamp of the refund transaction
}

The trigger._tag field gives the reason for the refund:

REJECTED_BRIDGE: a deposit Rhino.fi detected but rejected. originalDepositTxHash contains the hash of the original deposit, and amount and tokenSymbol have values.
UNSUPPORTED_TOKEN: a deposit of an unsupported token. originalDepositTxHash isn’t available, because the deposit wasn’t detected by Rhino.fi.

Event flows

For how events follow each other, see Webhook event state transitions.

Get Started

SDK

Migration guides

Webhook

API Integration

Smart Contracts

Widgets

General information

Events List

Bridge and bridge+swap events

Smart Deposit Address events

DEPOSIT_ADDRESS_CREATED

BRIDGE_PENDING, BRIDGE_ACCEPTED and BRIDGE_EXECUTED

DEPOSIT_ADDRESS_BRIDGE_REJECTED

DEPOSIT_ADDRESS_BRIDGE_REJECTED - UNSUPPORTED_TOKEN

DEPOSIT_ADDRESS_BRIDGE_DELAYED

SDA_REFUND_COMPLETED

Event flows

​Bridge and bridge+swap events

​Smart Deposit Address events

​DEPOSIT_ADDRESS_CREATED

​BRIDGE_PENDING, BRIDGE_ACCEPTED and BRIDGE_EXECUTED

​DEPOSIT_ADDRESS_BRIDGE_REJECTED

​DEPOSIT_ADDRESS_BRIDGE_REJECTED - UNSUPPORTED_TOKEN

​DEPOSIT_ADDRESS_BRIDGE_DELAYED

​SDA_REFUND_COMPLETED

​Event flows

Bridge and bridge+swap events

Smart Deposit Address events

DEPOSIT_ADDRESS_CREATED

BRIDGE_PENDING, BRIDGE_ACCEPTED and BRIDGE_EXECUTED

DEPOSIT_ADDRESS_BRIDGE_REJECTED

DEPOSIT_ADDRESS_BRIDGE_REJECTED - UNSUPPORTED_TOKEN

DEPOSIT_ADDRESS_BRIDGE_DELAYED

SDA_REFUND_COMPLETED

Event flows