Configuration Approval Callback
POST /v2/config_change_sign_request
This request expects a CallbackResponse object from the callback handler. If the callback handler does not respond within 30 seconds, Fireblocks fails the request. If your callback handler can’t respond within 30 seconds, you can use the retry mechanism by responding with RETRY.
Request parameters
(Optional) The Fireblocks API user ID associated with the cosigner device that’s signing this approval.
The type of configuration request. See Configuration types for the full list of values and their fields.
Additional information about the request. The shape depends on
type. See Configuration types.Configuration types
Each type below lists the fields Fireblocks sends inextraInfo for that specific configuration change.
Wallets and external accounts
UNMANAGED_WALLET
An event that involves address whitelisting. This type also covers theUNMANAGED_V2 internal request type — both surface as UNMANAGED_WALLET in the callback.
INTERNAL - Internal Wallets are addresses you control outside your Fireblocks workspace. Internal addresses display their current balance and are included in your workspace’s total billable address count.EXTERNAL - External Wallets are addresses managed by your clients and counterparties.CONTRACT - Contract Wallets are addresses of smart contracts you want to interact with. Currently, this only applies to smart contracts on EVM-compatible blockchains.The name of the internal, external, or contract wallet you want to approve adding an address to.
The ID of the internal, external, or contract wallet that you want to approve adding an address to.
The ID of the asset to add to this wallet. Use GET supported assets request to retrieve more information about an asset.
Destination address tag for Ripple; destination memo for EOS, Stellar, Hedera, & DigitalBits; destination note for Algorand; bank transfer description for fiat providers.Note: For Stellar, the memo must be a string representation of an integer between “0” and “2147483647”. Setting the memo to other values for Stellar assets will result in a failed request with an error message.
(Optional) Extra address metadata, present only when the whitelisting request originated from certain workspace flows.
UNMANAGED_DAPP
An event that involves adding an unmanaged dApp connection to your workspace.EXCHANGE, FIAT_ACCOUNT, and CONNECTED_ACCOUNT
An event that involves adding an exchange account, fiat account, or connected account to your workspace. All three types share the same fields.(Optional) A JSON-formatted “key”:“value” string, where “key” is an asset symbol and “value” is its address. There can be multiple entries in the JSON. Only populated for
FIAT_ACCOUNT. Use supported_assets to retrieve asset symbols.Users and devices
ADD_USER
An event that involves adding a user to your workspace.DELETE_USER
An event that involves removing a user from your workspace.A newline-separated list of alerts related to deleting this user (for example, pending requests or owned resources), if any.
EDIT_USER_INFO
An event that involves editing a user’s name, email, or role.RE_ENROLL_DEVICE
An event where an admin re-enrolls a mobile device for one of the users. UnlikeADD_USER, this type has no CONSOLE/API field: the role value here is deliberately stripped of the API USER: prefix, so you can’t recover whether the user is a console or API user from this payload.
Cosigner and device pairing
COSIGNER_CHANGE_CALLBACK and PAIR_VIRTUAL_DEVICE
COSIGNER_CHANGE_CALLBACK changes the callback configuration (URL, certificate, JWT public key) of a device that’s already paired. PAIR_VIRTUAL_DEVICE pairs a new virtual (non-mobile) device using a pairing token.
Always
null in this payload for both types. The actual pairing token is generated after approval and delivered separately.Quorum and MPC configuration
CHANGE_QUORUM_THRESHOLD
An event where the admin updates the quorum threshold.CONFIGURE_OWNER_IN_ADMIN_QUORUM
An event that changes whether the workspace owner counts toward the admin quorum.SET_MPC_PROVISIONER
An event that designates a user as an MPC provisioner.IP allow list
ACTIVATE_IP_ALLOW_LIST
An event that turns the IP allow list on or off.ADD_IP_ADDRESS
An event that adds an IP address to the allow list.DELETE_IP_ADDRESS
An event that removes an IP address from the allow list.UPDATE_IP_ADDRESS
An event that updates an existing IP address on the allow list.dApp connections and MEV protection
ENABLE_ONE_TIME_ADDRESS
An event which involves enabling a particular transaction to a one-time address in the workspace. This type has noextraInfo fields.
ENABLE_NON_EVM_DAPPS_CONNECTIONS
An event that enables dApp connections for non-EVM blockchains.ENABLE_MEV_DAPPS, DISABLE_MEV_DAPPS, ENABLE_MEV_API, and DISABLE_MEV_API
An event that enables or disables MEV protection for dApp connections or API-initiated transactions. All four types share the same fields.Fireblocks Network
ADD_NETWORK_CONNECTION
An event of adding a Fireblocks Network new connection.(Optional) JSON representation of routing policy object. Only included in the payload sent to the connection’s initiating tenant, not the receiving tenant.
SET_NETWORK_CONNECTION_ROUTING_POLICY
An event where the admin configures the routing policy for each network connection.SET_NETWORK_ID_POLICY
An event of setting up the Fireblocks Network Network ID in case its profile is not discoverable.Policies and approval groups
POLICY_APPROVAL
An event that involves updating the Transaction Authorization Policy.POLICY_CHANGE
An event that involves a pending edit to the Transaction Authorization Policy before it’s published.(Optional) A summary of pending rule changes. Keys combine the rule type and verdict action (for example,
transferALLOWRules); values are display strings such as "3 Rules", not numeric counts. For a change spanning multiple policies, only the last policy’s counters are present.UPDATE_APPROVAL_GROUP_MAPPING
An event involving gathering a list of approvers for a particular admin operation.USERS_GROUP_APPROVAL
An event that involves creating, editing, or deleting a user group in your workspace. The fields included depend on thesubType.
(Optional) Users added to the group. Included when
subType is CREATE_USERS_GROUP or EDIT_USERS_GROUP.(Optional) Users removed from the group. Included when
subType is EDIT_USERS_GROUP. Same entry shape as addedUsers.(Optional) The IDs of the group’s members, as strings. Included when
subType is CREATE_USERS_GROUP or EDIT_USERS_GROUP.(Optional) The group’s members. Included when
subType is DELETE_USERS_GROUP. Same entry shape as addedUsers.REGISTER_EXTERNAL_KEYS_VALIDATOR_KEY
An event that registers a validator key for External Keys.Automation rules
ADD_ACTIVE_AUTOMATION_RULE, ADD_INACTIVE_AUTOMATION_RULE, EDIT_AUTOMATION_RULE, DELETE_AUTOMATION_RULE, ACTIVATE_AUTOMATION_RULE, and DEACTIVATE_AUTOMATION_RULE
An event that adds, edits, deletes, activates, or deactivates an automation rule. All six types share the same fields.The full automation rule definition submitted for this change. Its schema is defined by the Automation Rules API.
Protected tags
Editing, deleting, attaching, and detaching a protected tag requires quorum approval. These events carry those changes.EDIT_PROTECTED_TAG
An event that edits a protected tag.DELETE_PROTECTED_TAG
An event that deletes a protected tag.ATTACH_AND_DETACH_PROTECTED_TAGS
An event that attaches or detaches protected tags on one or more entities.CREATE_ENTITIES_WITH_TAG_ATTACHMENTS
An event that creates entities with protected tags attached.(Optional) The highest existing vault account ID at request time, used as a floor for the newly created IDs. Only present when
entityType is 1 (vault account).