Skip to navigation
Crypto

Activate Deposit Webhook

View as Markdown

Subscribes an address to deposit notifications, so you’re notified by webhook when it receives funds (see Webhooks You’ll Receive).

Body

FieldTypeRequiredRules
networkIdstringyesNetwork id.
addressstringyesOne of your generated deposit addresses on that network (exact match).

Can be called once per address; a second call returns Webhook is already enabled for this address. subscriptionId is the notification subscription reference - keep it for support queries.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Request

This endpoint expects an object.
networkIdstringOptional
addressstringOptional

Response

OK
statusstringOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error