Home API Reference VaultsCreate Webhook Events

POST/vaults/create-webhook-events/{id}

Create Webhook Events

Outcome - Creates and configures webhook events for a specific vault.

Path Parameters

idnumber

The ID of the webhook

Body Parameters

retryCountnumberrequired

Number of retries for failed webhook deliveries

retryPeriodstringrequired

Period between retries (e.g., '15-minute')

eventsobjectrequired

Object containing arrays of event names grouped by category

Show child parameters (4)

transactionsarray

List of transaction events

vaultarray

List of vault events

assetsarray

List of asset events

networksarray

List of network events

Responses

Response attributes

messagestring

Success message

dataobject

Created webhook and event details

Show child attributes (8)

idnumber

Webhook ID

urlstring

Webhook URL

retryCountnumber

Number of retries

vaultIdnumber

Vault ID

retryPeriodstring

Retry period

eventsobject

Subscribed events details

Show child attributes (6)

transactionsobject

Transaction events subscription details

vaultobject

Vault events subscription details

assetsobject

Asset events subscription details

networksobject

Network events subscription details

tokensobject

Token events subscription details

paymentVaultOrderobject

Payment vault order events subscription details

subscribed_events_countnumber

Total number of subscribed events

eventsDescriptionobject

Description of available events

statusnumber

HTTP status code

Was this page helpful?

PreviousVerify Webhook NextUpdate 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/create-webhook-events/{id}

1	curl --request POST \
2	--url 'https://YOUR-SUBDOMAIN.api.roxcustody.com/api/integration/vaults/create-webhook-events/{id}' \
3	--header 'Content-Type: application/json' \
4	--header 'X-ACCESS-TOKEN: YOUR-ACCESS-TOKEN' \
5	--data '{
6	"retryCount": 5,
7	"retryPeriod": "15-minute",
8	"events": {
9	"transactions": [
10	"create_transaction",
11	"broadcasted_transaction",
12	"rejected_transaction",
13	"error_transaction",
14	"blockchain_rejected_transaction",
15	"completed_transaction",
16	"compliance_rule_transaction"
17	],
18	"vault": [
19	"sync_vault_wallets",
20	"sync_client_wallets"
21	],
22	"assets": [
23	"add_asset",
24	"activate_asset",
25	"deactivate_asset",
26	"hold_asset"
27	],
28	"networks": [
29	"hold_network"
30	]
31	}
32	}'

Response

Webhook created successfully

{

"message": "Webhook created successfully",

"data": {

"id": 3,

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

"retryCount": 5,

"vaultId": 9,

"retryPeriod": "15-minute",

"events": {

"transactions": {

"create_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"broadcasted_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"rejected_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"error_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"blockchain_rejected_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"completed_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"compliance_rule_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"cancel_transaction": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

}

"vault": {

"sync_vault_wallets": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"sync_client_wallets": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

}

"assets": {

"add_asset": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"activate_asset": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"deactivate_asset": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

"hold_asset": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

}

"networks": {

"hold_network": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": true

}

"tokens": {

"token_created_with_asset": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

}

"paymentVaultOrder": {

"create_payment_vault_order": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

"select_asset_payment_vault_order": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

"cancelled_payment_vault_order": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

"paid_payment_vault_order": {

"retryCount": 5,

"retryPeriod": "15-minute",

"subscribed": false

}

"subscribed_events_count": 14,

"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

}