Overview
API webhook overview
The Anchorage Digital Webhooks enable you to receive event-driven notifications for a number of operations and transactions across both Crypto and USD. Event notifications are configurable by endpoint and by event type.
Events Supported
Not all webhook events will appear in your account, as some are restricted to specific use cases.
| Event topic | Name | id | Response | Description |
|---|---|---|---|---|
| deposit | attributed | deposit.attributed | transactionId | Notification of successful completion of deposit attribution. |
| deposit | pending-attribution | deposit.pending-attribution | transactionId | Notification of a new deposit pending attribution. |
| transfer | completed | transfer.completed | transactionId | Notification of a successful transfer that is now completed. |
| transfer | failed | transfer.failed | transactionId | Notification of a failed transfer. |
| transfer | initiated | transfer.initiated | transactionId | Notification of a transfer that has successfully been initiated. |
| withdrawal | completed | withdrawal.completed | transactionId | Notification of a successful withdrawal completed. |
| withdrawal | failed | withdrawal.failed | transactionId | Notification of a failed withdrawal. |
| withdrawal | initiated | withdrawal.initiated | transactionId | Notification of a successful withdrawal initiated but still pending quorum approval and/or risk review. |
| program-customer-onboard | completed | program-customer-onboard.completed | customerIdapplicationType | Wealth Manager use case only Notification of a new RIA program Customer who has successfully completed and passed Onboarding KYC. Once completed, you are able to create a new subaccount. |
| program-customer | rfi | program-customer-onboard.rfi | customerId | Wealth Manager Use Case Only Notification of a request for more information for program customer onboarding information. |
| subaccount | opened | subaccount.opened | subaccountId | Wealth Manager use case only Notification of a new RIA program customer subaccount opening. |
| subaccount | subaccount-withdrawal-request-status-change | subaccount.subaccount-withdrawal-request-status-change | transactionId(Subaccount Tx) | Wealth Manager use case only Notification of a subaccount withdrawal request status change |
| collateral-package-state-change | margin-return | collateral-package-state-change.margin-return | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdamountReturnedcurrentLTVmarginReturnThresholdLTVmarginReturnReturnToLTV | Collateral Management use case only Notification of a collateral package entering the margin return state. This occurs when a collateral package loan-to-value (LTV) ratio falls below the collateral package's defined MarginReturn LTV |
| collateral-package-state-change | margin-call | collateral-package-state-change.margin-call | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdcurrentLTVamountRequiredmarginCallThresholdLTVactionRequiredcureDeadline | Collateral Management use case only Notification of a collateral package entering the margin call state. This occurs when a collateral package loan-to-value (LTV) ratio exceeds the collateral package's defined MarginCall LTV |
| collateral-package-state-change | healthy | collateral-package-state-change.healthy | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdcurrentLTV | Collateral Management use case only Notification of a collateral package entering the healthy state. This occurs when the collateral package loan-to-value (LTV) ratio is within the healthy range as defined in the collateral package |
| collateral-package-state-change | critical | collateral-package-state-change.critical | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdcurrentLTVcriticalThresholdLTV | Collateral Management use case only Notification of a collateral package entering the critical state. This occurs when the collateral package loan-to-value (LTV) ratio exceeds the collateral package's defined Critical LTV |
| collateral-package-state-change | cure-period-expired | collateral-package-state-change.cure-period-expired | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdcurePeriodaction | Collateral Management use case only Notification of a collateral package entering the cure period expired state. This occurs when the Cure Deadline time and date for the Margin Call has passed. |
| collateral-package-state-change | package-defaulted | collateral-package-state-change.package-defaulted | collateralPackageIdstatepledgorNamesecuredPartyNameexposureIdcurrentLTVdefaultNoticeWarning | Collateral Management use case only Notification of a collateral package entering the defaulted state |
Updated 8 months ago
Did this page help you?