webhooks

Test Webhook Endpoint

Test webhook endpoint connectivity.

With no body the test targets the org's saved singleton config — that is what the dashboard's "Test Webhook" button exercises. A url in the body overrides it (testing a not-yet-saved endpoint); when a config exists the event is still signed with its secret, so a receiver enforcing signature verification passes the test exactly as it would a real delivery.

Authenticated, and the target URL is SSRF-guarded (must resolve to a public address) before any request is made — otherwise the server could be coerced into probing internal/metadata endpoints.

post/api/webhooks/test

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/webhooks/test
  • Auth: HTTP bearer

Request body

urlstring uri nullable

Response

Successful Response

successboolean required
response_timeinteger required
status_codeinteger nullable
errorstring nullable
event_idstring nullable
response_bodystring nullable
response_headersobject nullable

Changes

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