Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Webhook

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.

post/api/v2/webhook/{webhookId}/verify

Path parameters

webhookIdstring required
Example:59cd72485007a239fb00282ed480da1f

Webhook public id

Request body

signaturestring required

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

notificationPayloadstring required

Webhook notification payload as JSON string

Example request

{
  "signature": "f34538037a1ae6f79bd7cee9d9a5552f21bee3027983d7730f424d94d9bab04a",
  "notificationPayload": "{\"userId\":\"66cd72485007a239fb00282ed480da1f\",\"username\":\"username@email.com\",\"tokenCreateTime\":\"2024-09-18T14:36:41.793Z\",\"59cd72485007a239fb00282ed480da1f\"}\""
}

Response

OK

webhookIdstring required
isValidboolean required