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.

On this page

• HTTP request
• URI Parameters
• Request Header
• Responses
• Security
• Python example
• Definitions
  • V1WebhookTestResponse

HTTP request

POST https://api.parsewise.ai/api/v1/webhooks/{id}/test/

URI Parameters

Name	In	Required	Type	Description
id	path	Yes	string (uuid)

Request Header

Name	Required	Type	Description
X-API-Key	Yes	string	API key with the pw_live_ prefix. See Authentication.

Responses

Status	Type	Description
200	V1WebhookTestResponse	—

Security

• ApiKeyAuth — apiKey — in X-API-Key header. API key with pw_live_ prefix.

Python example

import os
import requests

API_KEY = os.environ["PARSEWISE_API_KEY"]
BASE_URL = "https://api.parsewise.ai/api/v1"

id = "<uuid>"

resp = requests.post(
    f"{BASE_URL}/webhooks/{id}/test/",
    headers={"X-API-Key": API_KEY},
)
resp.raise_for_status()
print(resp.json() if resp.content else None)

Definitions

V1WebhookTestResponse

Result of POST /api/v1/webhooks/<id>/test/.

Name	Required	Type	Description
ok	Yes	boolean	True if the destination returned 2xx.
status_code	Yes	integer (nullable)	HTTP status code returned by the destination, or null if no response was received.
duration_ms	Yes	integer	Wall-clock duration of the test request in milliseconds.
error	Yes	string (nullable)	Truncated error message when the test failed; null on success.
delivery_id	Yes	string	ID of the WebhookDelivery row created for this test.