Webhooks

Verify a webhook endpoint

Changed on

Send a test event to verify the webhook endpoint is properly configured and reachable. The request body accepts an optional 'eventType' field to specify which event type to test (e.g., 'transaction.created', 'transaction.updated'). If omitted from the request body, defaults to 'transaction.created'.

post/webhooks/{webhookEndpointId}/verify

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/webhooks/{webhookEndpointId}/verify
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

webhookEndpointIdstring uuid required

ID for the webhook

Request body

eventType'transaction.created' | 'transaction.updated' | 'checkingAccount.balance.updated' | 'savingsAccount.balance.updated' | 'treasuryAccount.balance.updated' | 'investmentAccount.balance.updated' | 'creditAccount.balance.updated'

Changes

  • ab652aa5aa8eRevision changes
    • breaking

      removed the success response with the status

    • warning

      removed subschema #2 from the request property allOf list

    • info

      added the success response with the status

  • 57d0bcefe5d1Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status