Smart Transfer events

This page covers all Smart Transfer events that can trigger webhook notifications, and their associated data objects for the Webhooks v2 service.

Event types

To receive a specific event, include its eventType in the webhook's notification object.

Event type	Data object returned
ticket.created	Ticket created
ticket.counterparty.added	Ticket counterparty added
ticket.counterparty_external_id.set	Ticket counterparty external ID set
ticket.note.added	Ticket note added
ticket.submitted	Ticket submitted
ticket.expires_at.set	Ticket expires at set
ticket.expires_in.set	Ticket expires in set
ticket.expired	Ticket expired
ticket.fulfilled	Ticket fulfilled
ticket.canceled	Ticket canceled
ticket.term.added	Ticket term added
ticket.term.updated	Ticket term updated
ticket.term.deleted	Ticket term deleted
ticket.term.funded	Ticket term funded
ticket.term.manually_funded	Ticket term manually funded
ticket.term.funding_canceled	Ticket term funding canceled
ticket.term.funding_failed	Ticket term funding failed
ticket.term.funding_completed	Ticket term funding completed
ticket.term.status_transaction_changed	Ticket term transaction status changed

Data objects

Ticket created

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
type	string	The type of settlement for the ticket: Currently, only async
status	string	The status of the ticket
createdByNetworkId	string	The network ID of the Fireblocks Network profile that created the ticket
createdByNetworkIdName	string	The name of the Fireblocks Network profile that created the ticket
createdAt	date	Time and date when the ticket was created
expiresIn	number	Expiration of the ticket in hours

Ticket counterparty added

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
networkId	string	Network ID of the connection receiving a ticket
networkIdName	string	Name of the Fireblocks Network profile receiving the ticket

Ticket counterparty external ID set

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
externalRefId	string	Any ID a customer adds to the system

Ticket note added

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
body	string	Text of the note
createdAt	date	Time and date when the note was created

Ticket submitted

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
expiresIn	number	Expiration of the ticket in hours
status	string	Status of the ticket
expiresAt	date	Date and time when the ticket expires
submittedAt	date	Date and time the ticket is submitted

Ticket expires at set

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
expiresAt	date	Date and time when the ticket expires

Ticket expires in set

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
expiresIn	number	Expiration of the ticket in hours

Ticket expired

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
status	string	Status of the ticket
expiresAt	date	Date and time when the ticket expired

Ticket fulfilled

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
fulfilledAt	date	Date and time when the ticket was fulfilled by both sides

Ticket canceled

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
canceledAt	date	Date and time when the ticket was canceled

Ticket term added

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
asset	string	Asset name being sent in the term
amount	string	Amount of the asset being sent
fromNetworkId	string	NetworkId from which the asset is being sent
toNetworkId	string	NetworkId to which the asset is being sent
status	string	Status of the ticket

Ticket term updated

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
asset	string	Asset name being sent in the term
amount	string	Amount of the asset being sent
fromNetworkId	string	NetworkId from which the asset is being sent
toNetworkId	string	NetworkId to which the asset is being sent

Ticket term deleted

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term

Ticket term funded

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
asset	string	Asset name of the asset being sent to fund the term
amount	string	Amount of the asset being sent to fund the term
networkConnectionId	string	Network ID funding the term
srcId	string	vaultId if srcType is VAULT_ACCOUNT; exchangeId if srcType is EXCHANGE; or fiatAccountId if srcType is FIAT_ACCOUNT
srcType	string	Type of the account from which the funds are originating; can be a vault, an exchange, or a fiat account
note	string	Text of the note
fee	string	Amount of fee paid for the transaction funding the term
feeLevel	string	Fee level being paid

Ticket term manually funded

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
txHash	string	TX hash of the transaction funding the term

Ticket term funding canceled

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
txStatus	string	Status of the transfer funding the term

Ticket term funding failed

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
txStatus	string	Status of the transfer funding the term

Ticket term funding completed

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
txSHash	string	TX hash of the transaction funding the term
txStatus	string	Status of the transfer funding the term

Ticket term transaction status changed

Parameter	Type	Description
ticketId	string	Unique ID for the ticket
termId	string	Unique ID of the term
txStatus	string	Status of the transfer funding the term