HomeAPI ReferenceVaultsCreate Webhook Events
POST/vaults/create-webhook-events/{id}

Create Webhook Events

Outcome - Chooses which events are sent to your webhook, and the default retry settings. Call it once after Verify Webhook; use Update Webhook Events for later changes. To subscribe to every event available to your vault type, send "events": [-1].

Path Parameters

idnumber

The ID of the webhook

Body Parameters

retryCountnumberrequiredmin(1)max(10)

How many times a failed delivery is retried.

retryPeriodstringrequired

Time between retries. One of: 1-minute, 5-minute, 15-minute, 30-minute, 1-hour, 2-hour, 3-hour, 4-hour, 5-hour.

eventsobject | arrayrequired

Events to subscribe to, grouped by category, for example {"transactions": ["create_transaction", "completed_transaction"]}. Or [-1] to subscribe to all events available to the vault type. Categories and events: transactions: create_transaction, broadcasted_transaction, rejected_transaction, error_transaction, blockchain_rejected_transaction, completed_transaction, compliance_rule_transaction, cancel_transaction, fiat_transaction_created, fiat_transaction_completed, fiat_transaction_failed, fiat_refund_created; vault: sync_vault_wallets, sync_client_wallets; assets: add_asset, activate_asset, deactivate_asset, hold_asset; networks: hold_network, activate_network; tokens: token_created_with_asset; paymentVaultOrder: paid_payment_vault_order, fiat_payment_vault_order_paid, fiat_payment_vault_order_refunded.

Responses

Response attributes

messagestring

Success message

dataobject

Webhook configuration

Show child attributes (9)
idnumber

Webhook ID. Use it in Create/Update Webhook Events.

urlstring

Your HTTPS endpoint

vaultIdnumber

Vault ID

retryCountnumber

Default number of retries for failed deliveries

retryPeriodstring

Default time between retries

authMethodstring

SECRET_HEADER or HMAC

eventsobject

Every event available to this vault type, grouped by category, with subscribed, retryCount and retryPeriod

subscribedEventsCountnumber

Number of events you are subscribed to

eventsDescriptionobject

What each event means

statusnumber

HTTP status code

Was this page helpful?