Home API Reference VaultsVerify Webhook

POST/vaults/verify-webhook

Verify Webhook

Outcome - Verifies the vault webhook URL and secret.

Body Parameters

urlstringrequired

The webhook URL to verify

secretstringrequired

The webhook secret to verify

Responses

Response attributes

messagestring

Success message

dataobject

Verified webhook details

Show child attributes (7)

urlstring

Verified webhook URL

retryCountnumber

Number of retries

vaultIdnumber

Vault ID

idnumber

Webhook ID

retryPeriodstring

Retry period

subscribed_events_countnumber

Number of subscribed events

eventsDescriptionobject

Description of available events

Show child attributes (20)

create_transactionstring

Fires when a new transaction is created.

compliance_rule_transactionstring

Fires when a new compliance rule transaction is created

broadcasted_transactionstring

Fires when a transaction is being broadcast to the blockchain network.

rejected_transactionstring

Fires when a transaction is rejected by the admin.

cancel_transactionstring

Fires when a transaction is cancelled.

error_transactionstring

Fires when an unexpected error occurs during transaction processing.

blockchain_rejected_transactionstring

Fires when a transaction is rejected by the blockchain network.

completed_transactionstring

Fires when a transaction is confirmed and successfully completed.

sync_vault_walletsstring

Fires when vault wallets are synchronized with the system.

sync_client_walletsstring

Fires when client wallets are synchronized with the system.

add_assetstring

Fires when a new asset is added to a vault.

activate_assetstring

Fires when an asset is activated and made available for use.

deactivate_assetstring

Fires when an asset is deactivated and becomes unavailable.

hold_assetstring

Fires when an asset is placed on hold or reactivated by a corporate admin or Roxcustody super admin.

hold_networkstring

Fires when a blockchain network is placed on hold or reactivated by a corporate admin or Roxcustody super admin.

token_created_with_assetstring

Fires when a new security token is created.

create_payment_vault_orderstring

Fires when a new payment vault order is created.

select_asset_payment_vault_orderstring

Fires when an asset is selected for a payment vault order.

cancelled_payment_vault_orderstring

Fires when a payment vault order is cancelled.

paid_payment_vault_orderstring

Fires when a payment vault order is marked as paid.

statusnumber

HTTP status code

Was this page helpful?

PreviousGet Master Wallet NextCreate Webhook Events

Base URL

Production

https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration

Sandbox

https://YOUR-SUBDOMAIN.api-sandbox.roxcustody.com/api/integration

Language Box

POST/vaults/verify-webhook

1	curl --request POST \
2	--url 'https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration/vaults/verify-webhook' \
3	--header 'Content-Type: application/json' \
4	--header 'X-ACCESS-TOKEN: YOUR-ACCESS-TOKEN' \
5	--data '{
6	"url": "https://miya-aurorean-incidentally.ngrok-free.dev/webhook",
7	"secret": "aaaa"
8	}'

Response

Webhook verified successfully

{

"message": "Webhook verified successfully",

"data": {

"url": "https://miya-aurorean-incidentally.ngrok-free.dev/webhook",

"retryCount": 5,

"vaultId": 13,

"id": 2,

"retryPeriod": "30-minute",

"subscribed_events_count": 0,

"eventsDescription": {

"create_transaction": "Fires when a new transaction is created.",

"compliance_rule_transaction": "Fires when a new compliance rule transaction is created",

"broadcasted_transaction": "Fires when a transaction is being broadcast to the blockchain network.",

"rejected_transaction": "Fires when a transaction is rejected by the admin.",

"cancel_transaction": "Fires when a transaction is cancelled.",

"error_transaction": "Fires when an unexpected error occurs during transaction processing.",

"blockchain_rejected_transaction": "Fires when a transaction is rejected by the blockchain network.",

"completed_transaction": "Fires when a transaction is confirmed and successfully completed.",

"sync_vault_wallets": "Fires when vault wallets are synchronized with the system.",

"sync_client_wallets": "Fires when client wallets are synchronized with the system.",

"add_asset": "Fires when a new asset is added to a vault.",

"activate_asset": "Fires when an asset is activated and made available for use.",

"deactivate_asset": "Fires when an asset is deactivated and becomes unavailable.",

"hold_asset": "Fires when an asset is placed on hold or reactivated by a corporate admin or Roxcustody super admin.",

"hold_network": "Fires when a blockchain network is placed on hold or reactivated by a corporate admin or Roxcustody super admin.",

"token_created_with_asset": "Fires when a new security token is created.",

"create_payment_vault_order": "Fires when a new payment vault order is created.",

"select_asset_payment_vault_order": "Fires when an asset is selected for a payment vault order.",

"cancelled_payment_vault_order": "Fires when a payment vault order is cancelled.",

"paid_payment_vault_order": "Fires when a payment vault order is marked as paid."

}

"status": 201

}