Bridge session webhook

Information about a new bridge session created

WEBHOOK /bridge/webhook

Example

{
  "id": "<string>",
  "direction": "ethereum-to-stacks",
  "amount": "<string>",
  "status": "initiated",
  "ethereumAddress": "<string>",
  "stacksAddress": "<string>",
  "depositTxHash": "<string>",
  "burnTxHash": "<string>",
  "gasTxHash": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Bridge session created

id · string · required

Unique session identifier

direction · enum<string> · required

Bridge direction

Available options: ethereum-to-stacks, stacks-to-ethereum

amount · string · required

Amount to bridge

status · enum<string> · required

Current bridge status

Available options: initiated, wallet-created, awaiting-deposit, deposit-confirmed, approving, depositing, minting, gas-sent, burning, completed, withdrawing, failed

ethereumAddress · string

Ethereum address involved in bridge

stacksAddress · string

Stacks address involved in bridge

depositTxHash · string

Deposit transaction hash

burnTxHash · string

Burn transaction hash

gasTxHash · string

Gas transaction hash

createdAt · number

Session creation timestamp (ms)

updatedAt · number

Last update timestamp (ms)

error · string

Error message if bridge failed

Response

200

Return a 200 status to indicate that the data was received successfully