Skip to main content
Deprecation noticeWebhooks v1 will be deprecated on June 15th, 2026. Please use the Developer Center in the Fireblocks Console to upgrade to Webhooks V2, which offers improved reliability, performance, and observability. For upgrade steps and event mapping, see the Webhooks v2 Migration Guide.

​
Settlement Created

A notification is sent when a new settlement is initiated in the workspace.
ParameterTypeDescription
typestringSETTLEMENT_CREATED
tenantIdstringUnique ID of your Fireblocks workspace.
timestampnumberTimestamp in milliseconds.
datasettlementDetailsSettlement details.

​
settlementDetails

ParameterTypeDescription
collateralAccountIdstringThe collateral account ID.
settlementIdstringUnique settlement ID provided by Fireblocks.
isForceSettlementbooleanA flag or condition that indicates whether a settlement should be forcibly executed, overriding normal settlement procedures.
exchangeAccountIdstringThe ID of the exchange account.
toExchangedata [array]All settlement transaction details are required to be sent to the exchange.
toCollateraldata [array]All settlement transaction details are required to be sent to the collateral account.

​
toExchange

ParameterTypeDescription
txIdstringThe transaction ID (within the main workspace).
assetIdstringThe 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.
amountstringThe actual amount requested for transfer.

​
toCollateral

ParameterTypeDescription
txIdstringThe transaction ID (within the main workspace).
assetIdstringThe 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 .
amountstringThe actual amount requested for transfer.

​
Sample Payload

{
	"type": "SETTLEMENT_CREATED",
	"tenantId": "your-tenant-id", (main tenant Id)
	"timestamp": 1633036800000,
	"settlementDetails": {
		"collateralAccountId": "collateral-account-id", COLLATERAL Account ID (not collateral ID)
		"settlementId": "settlement-id",
		"isForceSettlement": false,
		"toExchange": [
	{
		"txId": "transaction-id-1",
	 	"assetId": "asset-id-1",
	 	"amount": "1000",
	}],
	"toCollateral": [
	{
    "txId": "transaction-id-2",
    "assetId": "asset-id-2",
    "amount": "500",
  }]
 }
}