REST API›Wallet & Transact›Webhook

POST

Verify Webhook Notification

Verify that a webhook notification comes from BitGo based on webhook signature and payload. If the X-Signature-SHA256 header is absent from the notification, use the Create webhook secret endpoint to generate a secret for your enterprise or organization. The requester must be an admin of the specified enterprise or organization.

Path Params

  • webhookId string required
    Webhook public id

    at least 1 characters · matches ^[0-9a-f]{32}$

Body Params

object

  • signature string required
    Webhook notification signature calculated based on the payload and webhook secret. Found in the HTTP header X-Signature-SHA256 of the notification.

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

  • notificationPayload string required
    Webhook notification payload as JSON string

Responses

200
OK

Response Body

object

  • webhookId string required
  • isValid boolean required
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id