Skip to main content

Event reference

All webhook events share a common envelope. Below is the full schema for each event type.

Envelope

Payment events

payment.received

Fired when a payment is successfully verified and the vault is created.

Vault events

vault.sealed

Fired when vault.seal() is called.

vault.expiring

Fired 1 hour before vault TTL expires.

vault.expired

Fired when vault expires and contents are deleted.

Deposit events

deposit.success

Fired when a deposit is detected on a BYO wallet.

Transfer events

transfer.completed

Fired when a bridge transfer is confirmed on the destination chain.

transfer.failed

Fired when a bridge transfer fails and funds are refunded.

Withdrawal events

withdrawal.completed

withdrawal.failed