Webhook

Simulate wallet webhook

Changed on

Simulates and tests a webhook so you can view its response. A transferId, pendingApprovalId or txRequestId is required.

post/api/v2/{coin}/wallet/{walletId}/webhooks/{webhookId}/simulate

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/{coin}/wallet/{walletId}/webhooks/{webhookId}/simulate
  • Auth
    none declared

Path parameters

coinstring required

A cryptocurrency or token ticker symbol.

Example:btc
walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID.

webhookIdstring required
Example:59cd72485007a239fb00282ed480da1f

Request body

OR
OR
OR
OR

Example request

{
  "transferId": "59cd72485007a239fb00282ed480da1f"
}

Response

OK

Example response

{
  "webhookNotifications": [
    {
      "wallet": "59cd72485007a239fb00282ed480da1f",
      "transfer": "59cd72485007a239fb00282ed480da1f",
      "id": "59cd72485007a239fb00282ed480da1f",
      "type": "transfer",
      "enterprise": "59cd72485007a239fb00282ed480da1f",
      "organization": "59cd72485007a239fb00282ed480da1f",
      "bankAccount": "59cd72485007a239fb00282ed480da1f",
      "url": "https://your.server.com/webhook",
      "coin": "btc",
      "state": "new",
      "webhook": "59cd72485007a239fb00282ed480da1f",
      "version": 2
    }
  ]
}

Changes

  • 30741a6c8193Revision changes
    • warning

      added the new allocationSettlementFailed enum value to the ////// response property for the response status

  • 021ae042735eRevision changes
    • warning

      added the new allocationAccepted enum value to the ////// response property for the response status

    • warning

      added the new allocationRequest enum value to the ////// response property for the response status