Off Exchange event types
To receive a specific event, include its eventType in the webhook’s notification object.| Event type | Data object returned |
|---|---|
| settlement.created | settlementDetails |
| collateral.status.updated | settlementDetails |
Data objects
settlementDetails
| Parameter | Type | Description |
|---|---|---|
| collateralAccountId | string | The collateral account ID. |
| settlementId | string | Unique settlement ID provided by Fireblocks. |
| isForceSettlement | boolean | A flag or condition that indicates whether a settlement should be forcibly executed, overriding normal settlement procedures. |
| toExchange | data [array] | All settlement transaction details are required to be sent to the exchange. |
| toCollateral | data [array] | All settlement transaction details are required to be sent to the collateral account. |
toExchange
| Parameter | Type | Description |
|---|---|---|
| txId | string | The transaction ID (within the main workspace). |
| assetId | string | The ID of the transaction’s asset, applicable to TRANSFER, MINT, BURN, or ENABLE_ASSET operations. For a list of supported assets and their corresponding IDs, please refer here. |
| amount | string | The actual amount requested for transfer. |
toCollateral
| Parameter | Type | Description |
|---|---|---|
| txId | string | The transaction ID (within the main workspace). |
| assetId | string | The ID of the transaction’s asset, applicable to TRANSFER, MINT, BURN, or ENABLE_ASSET operations. For a list of supported assets and their corresponding IDs, please refer here. |
| amount | string | The actual amount requested for transfer. |