REST API›Wallet & Transact›Webhook

POST

Add block webhook

Adds a webhook that will result in an HTTP callback at the specified URL from BitGo when events are triggered.

Types of block webhooks:

  1. Block webhooks will fire when a new block is seen on the coin network.
  2. Wallet confirmation webhooks will fire when a wallet has been initialized.

Path Params

  • coin string required
    A cryptocurrency or token ticker symbol.

Body Params

object

  • type string enum required
    blockwallet_confirmation
  • url string uri required
    URL to fire the webhook to.
  • label string
    Label of the new webhook.
  • numConfirmations integer
    Number of confirmations before triggering the webhook. If 0 or unspecified, requests will be sent to the callback endpoint when the transfer is first seen and when it is confirmed.

    >= 0

Responses

200
OK

Response Body

object

  • type string enum
    blockwallet_confirmation
  • userId string

    matches ^[0-9a-f]{32}$

  • id string

    matches ^[0-9a-f]{32}$

  • label string
  • created string date-time
  • coin string
    A cryptocurrency or token ticker symbol.
  • type string enum
    Event type to listen to.
    txRequesttxRequestTransactiontransfertransactiontransactionRemovedtransactionExpireunspentExpirypendingapprovaladdress_confirmationlowFeeblockadmincircuitBreakertransaction_finality_on_l1lowFeeAddressBalancestuckTx
  • url string uri required
  • version integer
    2 for coins running on API v2.
  • numConfirmations integer
  • state string enum
    If active, indicates the webhook can trigger and send to the URL. If suspended, indicates the webhook can't trigger.
    activesuspended
  • lastAttempt string date-time
  • failingSince string date-time
  • successiveFailedAttempts integer
  • walletId string
  • allowBlockedHosts boolean
  • allToken boolean
  • txRequestStates array of string enums
    If present, only transaction request state changes from the list will trigger notifications. If not present, all transaction request state changes will trigger notifications.
    initializedpendingApprovalpendingUserCommitmentpendingUserRSharependingUserGSharereadyToSendpendingUserSignaturependingDeliverysigneddeliveredcanceledrejectedfailed
  • txRequestTransactionStates array of string enums
    If present, only transaction request transaction state changes from the list will trigger notifications. If not present, all transaction request transaction state changes will trigger notifications.
    initializedpendingSignatureeddsaPendingCommitmenteddsaPendingRShareeddsaPendingGSharereadyToCombineSharessignedhelddeliveredinvalidSignaturerejectedecdsaMPCv2Round1ecdsaMPCv2Round2ecdsaMPCv2Round3
  • identityStatus array of string enums
    If present, only identity status changes from the list will trigger notifications. If not present, all identity status changes will trigger notifications.
    approveddeclinedinput errorssn errorgov id errorssn verifiedgov id verifiedevaluating submissionawaiting document uploadrecords uploadedin reviewincomplete verificationsawaiting signaturesignature submittedinitiatingadditional information submitted
  • userKycState array of string enums
    If present, only user kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
    approvedpendingrejected
  • enterpriseKycState array of string enums
    If present, only enterprise kyc state changes from the list will trigger notifications. If not present, all kyc state changes will trigger notifications.
    approvedpendingrejected
400
Bad Request

Response Body

object

  • error string required
    Human-readable error message
  • requestId string required
    Client request id
  • context object
    Properties that apply to a specific error name
  • name string required
    Error code