2.0.0 • Published 5 days ago

@fireblocks/ts-sdk v2.0.0

Weekly downloads
-
License
MIT License
Repository
github
Last release
5 days ago

Official Fireblocks TypeScript SDK

npm version

The Fireblocks SDK allows developers to seamlessly integrate with the Fireblocks platform and perform a variety of operations, including managing vault accounts and executing transactions securely.

For detailed API documentation please refer to the Fireblocks API Reference.

Installation

To use the Fireblocks SDK, follow these steps:

Install the SDK using npm:

npm install @fireblocks/ts-sdk

Usage

Initializing the SDK

You can initialize the Fireblocks SDK in two ways, either by setting environment variables or providing the parameters directly:

use bash commands to set environment variables:

export FIREBLOCKS_BASE_PATH="https://sandbox-api.fireblocks.io/v1"
export FIREBLOCKS_API_KEY="my-api-key"
export FIREBLOCKS_SECRET_KEY="my-secret-key"

execute the following code to initialize the Fireblocks SDK:

import { Fireblocks } from "@fireblocks/ts-sdk";

// Create a Fireblocks API instance
const fireblocks = new Fireblocks();
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from "@fireblocks/ts-sdk";

const FIREBLOCKS_API_SECRET_PATH = "./fireblocks_secret.key";

// Initialize a Fireblocks API instance with local variables
const fireblocks = new Fireblocks({
    apiKey: "my-api-key",
    basePath: BasePath.Sandbox, // or assign directly to "https://sandbox-api.fireblocks.io/v1";
    secretKey: readFileSync(FIREBLOCKS_API_SECRET_PATH, "utf8"),
});

Basic Api Examples

async function createVault() {
    try {
        const vault = await fireblocks.vaults.createVaultAccount({
            createVaultAccountRequest: {
                name: 'My First Vault Account',
                hiddenOnUI: false,
                autoFuel: false
            }
        });
        return vault;
    } catch (e) {
        console.log(e);
    }
}
async function getVaultPagedAccounts(limit) {
    try {
        const vaults = await fireblocks.vaults.getPagedVaultAccounts({
            limit
        });
        return vaults;
    } catch (e) {
        console.log(e);
    }
}
import { TransferPeerPathType } from "@fireblocks/ts-sdk";

async function createTransaction(assetId, amount, srcId, destId) {
    let payload = {
        assetId,
        amount,
        source: {
            type: TransferPeerPathType.VaultAccount,
            id: String(srcId)
        },
        destination: {
            type: TransferPeerPathType.VaultAccount,
            id: String(destId)
        },
        note: "Your first transaction!"
    };
    const result = await fireblocks.transactions.createTransaction({ transactionRequest: payload });
    console.log(JSON.stringify(result, null, 2));
}

Documentation for API Endpoints

All URIs are relative to https://developers.fireblocks.com/reference/

ClassMethodHTTP requestDescription
ApiUserApicreateApiUserPOST /management/api_usersCreate Api user
ApiUserApigetApiUsersGET /management/api_usersGet Api users
AssetsApicreateAssetsBulkPOST /vault/assets/bulkBulk creation of wallets
AuditLogsApigetAuditLogsGET /management/audit_logsGet audit logs
AuditLogsApigetAuditsGET /auditsGet audit logs
BlockchainsAssetsApigetSupportedAssetsGET /supported_assetsList all asset types supported by Fireblocks
BlockchainsAssetsApiregisterNewAssetPOST /assetsRegister an asset
ComplianceApigetAmlPostScreeningPolicyGET /screening/aml/post_screening_policyAML - View Post-Screening Policy
ComplianceApigetAmlScreeningPolicyGET /screening/aml/screening_policyAML - View Screening Policy
ComplianceApigetPostScreeningPolicyGET /screening/travel_rule/post_screening_policyTravel Rule - View Post-Screening Policy
ComplianceApigetScreeningPolicyGET /screening/travel_rule/screening_policyTravel Rule - View Screening Policy
ComplianceApiupdateAmlScreeningConfigurationPUT /screening/aml/policy_configurationUpdate AML Configuration
ComplianceApiupdateScreeningConfigurationPUT /screening/configurationsTenant - Screening Configuration
ComplianceApiupdateTravelRuleConfigPUT /screening/travel_rule/policy_configurationUpdate Travel Rule Configuration
ComplianceScreeningConfigurationApigetAmlScreeningConfigurationGET /screening/aml/policy_configurationGet AML Screening Policy Configuration
ComplianceScreeningConfigurationApigetScreeningConfigurationGET /screening/travel_rule/policy_configurationGet Travel Rule Screening Policy Configuration
ConsoleUserApicreateConsoleUserPOST /management/usersCreate console user
ConsoleUserApigetConsoleUsersGET /management/usersGet console users
ContractInteractionsApigetDeployedContractAbiGET /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functionsReturn deployed contract\'s ABI
ContractInteractionsApireadCallFunctionPOST /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functions/readCall a read function on a deployed contract
ContractInteractionsApiwriteCallFunctionPOST /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functions/writeCall a write function on a deployed contract
ContractTemplatesApideleteContractTemplateByIdDELETE /tokenization/templates/{contractTemplateId}Delete a contract template by id
ContractTemplatesApideployContractPOST /tokenization/templates/{contractTemplateId}/deployDeploy contract
ContractTemplatesApigetConstructorByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/constructorReturn contract template\'s constructor
ContractTemplatesApigetContractTemplateByIdGET /tokenization/templates/{contractTemplateId}Return contract template by id
ContractTemplatesApigetContractTemplatesGET /tokenization/templatesList all contract templates
ContractTemplatesApigetFunctionAbiByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/functionReturn contract template\'s function
ContractTemplatesApiuploadContractTemplatePOST /tokenization/templatesUpload contract template
ContractsApiaddContractAssetPOST /contracts/{contractId}/{assetId}Add an asset to a contract
ContractsApicreateContractPOST /contractsCreate a contract
ContractsApideleteContractDELETE /contracts/{contractId}Delete a contract
ContractsApideleteContractAssetDELETE /contracts/{contractId}/{assetId}Delete a contract asset
ContractsApigetContractGET /contracts/{contractId}Find a specific contract
ContractsApigetContractAssetGET /contracts/{contractId}/{assetId}Find a contract asset
ContractsApigetContractsGET /contractsList contracts
CosignersBetaApigetApiKeyGET /cosigners/{cosignerId}/api_keys/{apiKeyId}Get API key
CosignersBetaApigetApiKeysGET /cosigners/{cosignerId}/api_keysGet all API keys
CosignersBetaApigetCosignerGET /cosigners/{cosignerId}Get cosigner
CosignersBetaApigetCosignersGET /cosignersGet all cosigners
CosignersBetaApirenameCosignerPATCH /cosigners/{cosignerId}Rename cosigner
DeployedContractsApigetDeployedContractByAddressGET /tokenization/contracts/{assetId}/{contractAddress}Return deployed contract data
DeployedContractsApigetDeployedContractByIdGET /tokenization/contracts/{id}Return deployed contract data by id
DeployedContractsApigetDeployedContractsGET /tokenization/contractsList deployed contracts data
ExchangeAccountsApiconvertAssetsPOST /exchange_accounts/{exchangeAccountId}/convertConvert exchange account funds from the source asset to the destination asset.
ExchangeAccountsApigetExchangeAccountGET /exchange_accounts/{exchangeAccountId}Find a specific exchange account
ExchangeAccountsApigetExchangeAccountAssetGET /exchange_accounts/{exchangeAccountId}/{assetId}Find an asset for an exchange account
ExchangeAccountsApigetPagedExchangeAccountsGET /exchange_accounts/pagedPagination list exchange accounts
ExchangeAccountsApiinternalTransferPOST /exchange_accounts/{exchangeAccountId}/internal_transferInternal transfer for exchange accounts
ExternalWalletsApiaddAssetToExternalWalletPOST /external_wallets/{walletId}/{assetId}Add an asset to an external wallet.
ExternalWalletsApicreateExternalWalletPOST /external_walletsCreate an external wallet
ExternalWalletsApideleteExternalWalletDELETE /external_wallets/{walletId}Delete an external wallet
ExternalWalletsApigetExternalWalletGET /external_wallets/{walletId}Find an external wallet
ExternalWalletsApigetExternalWalletAssetGET /external_wallets/{walletId}/{assetId}Get an asset from an external wallet
ExternalWalletsApigetExternalWalletsGET /external_walletsList external wallets
ExternalWalletsApiremoveAssetFromExternalWalletDELETE /external_wallets/{walletId}/{assetId}Delete an asset from an external wallet
ExternalWalletsApisetExternalWalletCustomerRefIdPOST /external_wallets/{walletId}/set_customer_ref_idSet an AML customer reference ID for an external wallet
FiatAccountsApidepositFundsFromLinkedDDAPOST /fiat_accounts/{accountId}/deposit_from_linked_ddaDeposit funds from DDA
FiatAccountsApigetFiatAccountGET /fiat_accounts/{accountId}Find a specific fiat account
FiatAccountsApigetFiatAccountsGET /fiat_accountsList fiat accounts
FiatAccountsApiredeemFundsToLinkedDDAPOST /fiat_accounts/{accountId}/redeem_to_linked_ddaRedeem funds to DDA
GasStationsApigetGasStationByAssetIdGET /gas_station/{assetId}Get gas station settings by asset
GasStationsApigetGasStationInfoGET /gas_stationGet gas station settings
GasStationsApiupdateGasStationConfigurationPUT /gas_station/configurationEdit gas station settings
GasStationsApiupdateGasStationConfigurationByAssetIdPUT /gas_station/configuration/{assetId}Edit gas station settings for an asset
InternalWalletsApicreateInternalWalletPOST /internal_walletsCreate an internal wallet
InternalWalletsApicreateInternalWalletAssetPOST /internal_wallets/{walletId}/{assetId}Add an asset to an internal wallet
InternalWalletsApideleteInternalWalletDELETE /internal_wallets/{walletId}Delete an internal wallet
InternalWalletsApideleteInternalWalletAssetDELETE /internal_wallets/{walletId}/{assetId}Delete a whitelisted address from an internal wallet
InternalWalletsApigetInternalWalletGET /internal_wallets/{walletId}Get assets for internal wallet
InternalWalletsApigetInternalWalletAssetGET /internal_wallets/{walletId}/{assetId}Get an asset from an internal wallet
InternalWalletsApigetInternalWalletsGET /internal_walletsList internal wallets
InternalWalletsApisetCustomerRefIdForInternalWalletPOST /internal_wallets/{walletId}/set_customer_ref_idSet an AML/KYT customer reference ID for an internal wallet
JobManagementApicancelJobPOST /batch/{jobId}/cancelCancel a running job
JobManagementApicontinueJobPOST /batch/{jobId}/continueContinue a paused job
JobManagementApigetJobGET /batch/{jobId}Get job details
JobManagementApigetJobTasksGET /batch/{jobId}/tasksReturn a list of tasks for given job
JobManagementApigetJobsGET /batch/jobsReturn a list of jobs belonging to tenant
JobManagementApipauseJobPOST /batch/{jobId}/pausePause a job
NFTsApigetNFTGET /nfts/tokens/{id}List token data by ID
NFTsApigetNFTsGET /nfts/tokensList tokens by IDs
NFTsApigetOwnershipTokensGET /nfts/ownership/tokensList all owned tokens (paginated)
NFTsApilistOwnedCollectionsGET /nfts/ownership/collectionsList owned collections (paginated)
NFTsApilistOwnedTokensGET /nfts/ownership/assetsList all distinct owned tokens (paginated)
NFTsApirefreshNFTMetadataPUT /nfts/tokens/{id}Refresh token metadata
NFTsApiupdateOwnershipTokensPUT /nfts/ownership/tokensRefresh vault account tokens
NFTsApiupdateTokenOwnershipStatusPUT /nfts/ownership/tokens/{id}/statusUpdate token ownership status
NFTsApiupdateTokensOwnershipSpamPUT /nfts/ownership/tokens/spamUpdate tokens ownership spam property
NFTsApiupdateTokensOwnershipStatusPUT /nfts/ownership/tokens/statusUpdate tokens ownership status
NetworkConnectionsApicheckThirdPartyRoutingGET /network_connections/{connectionId}/is_third_party_routing/{assetType}Retrieve third-party network routing validation by asset type.
NetworkConnectionsApicreateNetworkConnectionPOST /network_connectionsCreates a new network connection
NetworkConnectionsApicreateNetworkIdPOST /network_idsCreates a new Network ID
NetworkConnectionsApideleteNetworkConnectionDELETE /network_connections/{connectionId}Deletes a network connection by ID
NetworkConnectionsApideleteNetworkIdDELETE /network_ids/{networkId}Deletes specific network ID.
NetworkConnectionsApigetNetworkGET /network_connections/{connectionId}Get a network connection
NetworkConnectionsApigetNetworkConnectionsGET /network_connectionsList network connections
NetworkConnectionsApigetNetworkIdGET /network_ids/{networkId}Returns specific network ID.
NetworkConnectionsApigetNetworkIdsGET /network_idsReturns all network IDs, both local IDs and discoverable remote IDs
NetworkConnectionsApigetRoutingPolicyAssetGroupsGET /network_ids/routing_policy_asset_groupsReturns all enabled routing policy asset groups
NetworkConnectionsApisetNetworkIdDiscoverabilityPATCH /network_ids/{networkId}/set_discoverabilityUpdate network ID\'s discoverability.
NetworkConnectionsApisetNetworkIdNamePATCH /network_ids/{networkId}/set_nameUpdate network ID\'s name.
NetworkConnectionsApisetNetworkIdRoutingPolicyPATCH /network_ids/{networkId}/set_routing_policyUpdate network id routing policy.
NetworkConnectionsApisetRoutingPolicyPATCH /network_connections/{connectionId}/set_routing_policyUpdate network connection routing policy.
OTABetaApigetOtaStatusGET /management/otaReturns current OTA status
OTABetaApisetOtaStatusPUT /management/otaEnable or disable transactions to OTA
OffExchangesApiaddOffExchangePOST /off_exchange/addadd collateral
OffExchangesApigetOffExchangeCollateralAccountsGET /off_exchange/collateral_accounts/{mainExchangeAccountId}Find a specific collateral exchange account
OffExchangesApigetOffExchangeSettlementTransactionsGET /off_exchange/settlements/transactionsget settlements transactions from exchange
OffExchangesApiremoveOffExchangePOST /off_exchange/removeremove collateral
OffExchangesApisettleOffExchangeTradesPOST /off_exchange/settlements/tradercreate settlement for a trader
PaymentsPayoutApicreatePayoutPOST /payments/payoutCreate a payout instruction set
PaymentsPayoutApiexecutePayoutActionPOST /payments/payout/{payoutId}/actions/executeExecute a payout instruction set
PaymentsPayoutApigetPayoutGET /payments/payout/{payoutId}Get the status of a payout instruction set
PolicyEditorBetaApigetActivePolicyGET /tap/active_policyGet the active policy and its validation
PolicyEditorBetaApigetDraftGET /tap/draftGet the active draft
PolicyEditorBetaApipublishDraftPOST /tap/draftSend publish request for a certain draft id
PolicyEditorBetaApipublishPolicyRulesPOST /tap/publishSend publish request for a set of policy rules
PolicyEditorBetaApiupdateDraftPUT /tap/draftUpdate the draft with a new set of rules
ResetDeviceApiresetDevicePOST /management/users/{id}/reset_deviceResets device
SmartTransferApicancelTicketPUT /smart-transfers/{ticketId}/cancelCancel Ticket
SmartTransferApicreateTicketPOST /smart-transfersCreate Ticket
SmartTransferApicreateTicketTermPOST /smart-transfers/{ticketId}/termsCreate leg (term)
SmartTransferApifindTicketByIdGET /smart-transfers/{ticketId}Search Tickets by ID
SmartTransferApifindTicketTermByIdGET /smart-transfers/{ticketId}/terms/{termId}Search ticket by leg (term) ID
SmartTransferApifulfillTicketPUT /smart-transfers/{ticketId}/fulfillFund ticket manually
SmartTransferApifundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/fundDefine funding source
SmartTransferApigetSmartTransferUserGroupsGET /smart-transfers/settings/user-groupsGet user group
SmartTransferApimanuallyFundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/manually-fundManually add term transaction
SmartTransferApiremoveTicketTermDELETE /smart-transfers/{ticketId}/terms/{termId}Delete ticket leg (term)
SmartTransferApisearchTicketsGET /smart-transfersFind Ticket
SmartTransferApisetExternalRefIdPUT /smart-transfers/{ticketId}/external-idAdd external ref. ID
SmartTransferApisetTicketExpirationPUT /smart-transfers/{ticketId}/expires-inSet expiration
SmartTransferApisetUserGroupsPOST /smart-transfers/settings/user-groupsSet user group
SmartTransferApisubmitTicketPUT /smart-transfers/{ticketId}/submitSubmit ticket
SmartTransferApiupdateTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}Update ticket leg (term)
StakingBetaApiapproveTermsOfServiceByProviderIdPOST /staking/providers/{providerId}/approveTermsOfService
StakingBetaApiexecuteActionPOST /staking/chains/{chainDescriptor}/{actionId}
StakingBetaApigetAllDelegationsGET /staking/positions
StakingBetaApigetChainInfoGET /staking/chains/{chainDescriptor}/chainInfo
StakingBetaApigetChainsGET /staking/chains
StakingBetaApigetDelegationByIdGET /staking/positions/{id}
StakingBetaApigetProvidersGET /staking/providers
StakingBetaApigetSummaryGET /staking/positions/summary
StakingBetaApigetSummaryByVaultGET /staking/positions/summary/vaults
TokenizationApigetLinkedTokenGET /tokenization/tokens/{id}Return a linked token
TokenizationApigetLinkedTokensGET /tokenization/tokensList all linked tokens
TokenizationApiissueNewTokenPOST /tokenization/tokensIssue a new token
TokenizationApilinkPOST /tokenization/tokens/linkLink a token
TokenizationApiunlinkDELETE /tokenization/tokens/{id}Unlink a token
TransactionsApicancelTransactionPOST /transactions/{txId}/cancelCancel a transaction
TransactionsApicreateTransactionPOST /transactionsCreate a new transaction
TransactionsApidropTransactionPOST /transactions/{txId}/dropDrop ETH transaction by ID
TransactionsApiestimateNetworkFeeGET /estimate_network_feeEstimate the required fee for an asset
TransactionsApiestimateTransactionFeePOST /transactions/estimate_feeEstimate transaction fee
TransactionsApifreezeTransactionPOST /transactions/{txId}/freezeFreeze a transaction
TransactionsApigetTransactionGET /transactions/{txId}Find a specific transaction by Fireblocks transaction ID
TransactionsApigetTransactionByExternalIdGET /transactions/external_tx_id/{externalTxId}Find a specific transaction by external transaction ID
TransactionsApigetTransactionsGET /transactionsList transaction history
TransactionsApisetConfirmationThresholdByTransactionHashPOST /txHash/{txHash}/set_confirmation_thresholdSet confirmation threshold by transaction hash
TransactionsApisetTransactionConfirmationThresholdPOST /transactions/{txId}/set_confirmation_thresholdSet confirmation threshold by transaction ID
TransactionsApiunfreezeTransactionPOST /transactions/{txId}/unfreezeUnfreeze a transaction
TransactionsApivalidateAddressGET /transactions/validate_address/{assetId}/{address}Validate destination address
TravelRuleBetaApigetVASPByDIDGET /screening/travel_rule/vasp/{did}Get VASP details
TravelRuleBetaApigetVASPsGET /screening/travel_rule/vaspGet All VASPs
TravelRuleBetaApiupdateVaspPUT /screening/travel_rule/vasp/updateAdd jsonDidKey to VASP details
TravelRuleBetaApivalidateFullTravelRuleTransactionPOST /screening/travel_rule/transaction/validate/fullValidate Full Travel Rule Transaction
TravelRuleBetaApivalidateTravelRuleTransactionPOST /screening/travel_rule/transaction/validateValidate Travel Rule Transaction
UserGroupsBetaApicreateUserGroupPOST /management/user_groupsCreate user group
UserGroupsBetaApideleteUserGroupDELETE /management/user_groups/{groupId}Delete user group
UserGroupsBetaApigetUserGroupGET /management/user_groups/{groupId}Get user group
UserGroupsBetaApigetUserGroupsGET /management/user_groupsList user groups
UserGroupsBetaApiupdateUserGroupPUT /management/user_groups/{groupId}Update user group
UsersApigetUsersGET /usersList users
VaultsApiactivateAssetForVaultAccountPOST /vault/accounts/{vaultAccountId}/{assetId}/activateActivate a wallet in a vault account
VaultsApicreateLegacyAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacyConvert a segwit address to legacy format
VaultsApicreateMultipleAccountsPOST /vault/accounts/bulkBulk creation of new vault accounts
VaultsApicreateVaultAccountPOST /vault/accountsCreate a new vault account
VaultsApicreateVaultAccountAssetPOST /vault/accounts/{vaultAccountId}/{assetId}Create a new wallet
VaultsApicreateVaultAccountAssetAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addressesCreate new asset deposit address
VaultsApigetAssetWalletsGET /vault/asset_walletsList asset wallets (Paginated)
VaultsApigetMaxSpendableAmountGET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amountGet the maximum spendable amount in a single transaction.
VaultsApigetPagedVaultAccountsGET /vault/accounts_pagedList vault accounts (Paginated)
VaultsApigetPublicKeyInfoGET /vault/public_key_infoGet the public key information
VaultsApigetPublicKeyInfoForAddressGET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_infoGet the public key for a vault account
VaultsApigetUnspentInputsGET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputsGet UTXO unspent inputs information
VaultsApigetVaultAccountGET /vault/accounts/{vaultAccountId}Find a vault account by ID
VaultsApigetVaultAccountAssetGET /vault/accounts/{vaultAccountId}/{assetId}Get the asset balance for a vault account
VaultsApigetVaultAccountAssetAddressesPaginatedGET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginatedList addresses (Paginated)
VaultsApigetVaultAssetsGET /vault/assetsGet asset balance for chosen assets
VaultsApigetVaultBalanceByAssetGET /vault/assets/{assetId}Get vault balance by asset
VaultsApihideVaultAccountPOST /vault/accounts/{vaultAccountId}/hideHide a vault account in the console
VaultsApisetCustomerRefIdForAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_idAssign AML customer reference ID
VaultsApisetVaultAccountAutoFuelPOST /vault/accounts/{vaultAccountId}/set_auto_fuelTurn autofueling on or off
VaultsApisetVaultAccountCustomerRefIdPOST /vault/accounts/{vaultAccountId}/set_customer_ref_idSet an AML/KYT customer reference ID for a vault account
VaultsApiunhideVaultAccountPOST /vault/accounts/{vaultAccountId}/unhideUnhide a vault account in the console
VaultsApiupdateVaultAccountPUT /vault/accounts/{vaultAccountId}Rename a vault account
VaultsApiupdateVaultAccountAssetAddressPUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}Update address description
VaultsApiupdateVaultAccountAssetBalancePOST /vault/accounts/{vaultAccountId}/{assetId}/balanceRefresh asset balance data
Web3ConnectionsApicreatePOST /connections/wcCreate a new Web3 connection.
Web3ConnectionsApigetGET /connectionsList all open Web3 connections.
Web3ConnectionsApiremoveDELETE /connections/wc/{id}Remove an existing Web3 connection.
Web3ConnectionsApisubmitPUT /connections/wc/{id}Respond to a pending Web3 connection request.
WebhooksApiresendTransactionWebhooksPOST /webhooks/resend/{txId}Resend failed webhooks for a transaction by ID
WebhooksApiresendWebhooksPOST /webhooks/resendResend failed webhooks
WhitelistIpAddressesApigetWhitelistIpAddressesGET /management/api_users/{userId}/whitelist_ip_addressesGets whitelisted ip addresses
WorkspaceStatusBetaApigetWorkspaceStatusGET /management/workspace_statusReturns current workspace status

Documentation for Models

2.0.0

5 days ago

1.1.0

26 days ago

1.0.1

1 month ago

1.0.0

1 month ago

3.0.6-beta

1 month ago

3.0.5-beta

2 months ago

3.0.4-beta

2 months ago

3.0.3-beta

3 months ago

3.0.2-beta

3 months ago

2.1.0-beta

6 months ago

2.0.19-beta

9 months ago

1.0.19-beta

10 months ago

1.0.18-beta

10 months ago

1.0.17-beta

10 months ago

1.0.16-beta

10 months ago

1.0.15-beta

10 months ago

1.0.13-beta

10 months ago

1.0.12-beta

10 months ago

1.0.11-beta

10 months ago

1.0.10-beta

10 months ago

1.0.9-beta

10 months ago

1.0.8-beta

10 months ago

1.0.7-beta

10 months ago

1.0.6-beta

10 months ago

1.0.5-beta

10 months ago

1.0.4-beta

10 months ago

1.0.3-beta

10 months ago

1.0.2-beta

10 months ago