webhooks

Test Webhook Subscription

Send a synthetic test event to a webhook subscription.

Requires the webhooks:write scope on the API key.

post/v1/webhooks/{webhook_id}/test

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/webhooks/{webhook_id}/test
  • Auth: HTTP bearer

Path parameters

webhook_idstring uuid required

ID of the webhook.

Response

Successful Response

deliveredboolean required

Whether the receiver accepted the test payload.

errorstring nullable required

Failure reason when delivered is false.

Changes

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