This page describes all events relating to smart transfer webhooks that produce webhook notifications, and their associated data objects for webhooks v2.
📘
Note:
Both webhooks v1 and v2 still working as expected but we are highly recommend you to use webhooks v2. Please refer to the each table to see the details of object structure.
| Webhook v1 event | Webhook v2 event | Description |
|---|
| TICKET_CREATED | ticket.created | A notification is sent when a Smart Transfer ticket is created. |
| TICKET_COUNTERPARTY_ADDED | ticket.counterparty.added | A notification is sent when a counterparty is added to a Smart Transfer ticket. |
| TICKET_COUNTERPARTY_EXTERNAL_ID_SET | ticket.counterparty_external_id.set | A notification is sent when an external ID is added to a Smart Transfer ticket. |
| TICKET_NOTE_ADDED | ticket.note.added | A notification is sent when a note is added to a Smart Transfer ticket. |
| TICKET_SUBMITTED | ticket.submitted | A notification is sent when a Smart Transfer ticket is submitted. |
| TICKET_EXPIRES_AT_SET | ticket.expires_at.set | A notification is sent when a Smart Transfer ticket expiration is set at a certain time. |
| TICKET_EXPIRES_IN_SET | ticket.expires_in.set | A notification is sent when a Smart Transfer ticket expiration is set in a set amount of time such as in 1 month or 1 hour. |
| TICKET_EXPIRED | ticket.expired | A notification is sent when a Smart Transfer ticket expires. |
| TICKET_FULFILLED | ticket.fulfilled | A notification is sent when a Smart Transfer ticket is funded. |
| TICKET_CANCELED | ticket.cancelled | A notification is sent when a Smart Transfer ticket is canceled. |
| TICKET_TERM_ADDED | ticket.term.added | A notification is sent when a Smart Transfer ticket term is added. |
| TICKET_TERM_UPDATED | ticket.term.updated | A notification is sent when a Smart Transfer ticket term is updated. |
| TICKET_TERM_DELETED | ticket.term.deleted | A notification is sent when a Smart Transfer ticket term is deleted. |
| TICKET_TERM_FUNDED | ticket.term.funded | A notification is sent when a Smart Transfer ticket term is funded. |
| TICKET_TERM_MANUALLY_FUNDED | ticket.term.manually_funded | A notification is sent when a Smart Transfer ticket is manually funded. |
| TICKET_TERM_FUNDING_CANCELED | ticket.term.funding_canceled | A notification is sent when a Smart Transfer ticket funding is canceled. |
| TICKET_TERM_FUNDING_FAILED | ticket.term.funding_failed | A notification is sent when a Smart Transfer ticket funding is failed. |
| TICKET_TERM_FUNDING_COMPLETED | ticket.term.funding_completed | A notification is sent when a Smart Transfer ticket funding is completed. |
| TICKET_STATUS_TRANSACTION_CHANGED | ticket.term.status_transaction_changed | A notification is sent when a Smart Transfer ticket status transaction is changed. |
For details object on each event, please refer to tables below.
| 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 |
| 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 |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| externalRefId | string | Any ID a customer adds to the system |
| 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 |
| 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 |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| expiresAt | date | Date and time when the ticket expires |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| expiresIn | number | Expiration of the ticket in hours |
| 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 |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| fulfilledAt | date | Date and time when the ticket was fulfilled by both sides |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| canceledAt | date | Date and time when the ticket was canceled |
| 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 |
| 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 |
| Parameter | Type | Description |
|---|
| ticketId | string | Unique ID for the ticket |
| termId | string | Unique ID of the term |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
