Webhooks

Send a synthetic test event

Synchronously sends one synthetic webhook.ping event to the subscription target so you can verify your handler before any real event fires. This call returns the result of the single attempt — there are no retries. The synthetic delivery is recorded as a WebhookDelivery row for audit.

post/webhooks/{id}/test/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

Response

okboolean required

True if the destination returned 2xx.

status_codeinteger nullable required

HTTP status code returned by the destination, or null if no response was received.

duration_msinteger required

Wall-clock duration of the test request in milliseconds.

errorstring nullable required

Truncated error message when the test failed; null on success.

delivery_idstring required

ID of the WebhookDelivery row created for this test.

Changes

No recorded changes to this operation across all 1 revision of this API.