Webhook Subscriptions

Test a webhook subscription

Sends test event data to the URL of the webhook subscription identified by webhook_id, so you can confirm your handler is reachable and responding correctly.

The response reports what your endpoint returned: its HTTP status, response headers, and body. Use it to verify a new subscription before relying on live events.

See the implementing webhooks guide (TOL / BYOL / Omnibus) for handler requirements, subscription types, and batching.

post/webhooks/{webhook_id}/test

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/webhooks/{webhook_id}/test
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: webhooks:admin)

Response

OK

urlstring required

The URL that the test data was delivered to.

Changes

No recorded changes to this operation across all 25 revisions of this API.