Skip to content
GitHub

Webhook event types

Webhooks notify you of specific events that occur within your Rafiki instance allowing you to integrate Interledger payments with your system and business processes. For example, Rafiki will notify you when one of your account holders has received an Interledger payment, at which point you would credit their account on your ledger.

The following is an enumeration of all of Rafiki’s webhook event types along with their descriptions, which you must listen to and handle.

ValueDescription
incoming_payment.createdAn incoming payment has been created.
incoming_payment.completedAn incoming payment is complete and will not accept any additional incoming funds.
incoming_payment.expiredAn incoming payment expired and will not accept any additional incoming funds.
outgoing_payment.createdAn outgoing payment was created.
outgoing_payment.completedAn outgoing payment completed.
outgoing_payment.failedAn outgoing payment partially or completely failed.
wallet_address.not_foundA requested wallet address was not found.
wallet_address.web_monetizationWeb Monetization payments received via STREAM.
asset.liquidity_lowAsset liquidity has dropped below defined threshold.
peer.liquidity_lowPeer liquidity has dropped below defined threshold.