Webhooks

Test a webhook

Not yet available on the test environment. Calling this route on test-api.kashier.io returns a 404, so the "Try it" panel below cannot succeed yet.

Sends a signed sample payload to a webhook's configured URL so you can confirm the endpoint is reachable and your signature verification works — without waiting for a real event. The test delivery is recorded like any other delivery, but flagged isTest: true so it's distinguishable in your delivery history.

post/v2/webhooks/{webhookId}/test

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/webhooks/{webhookId}/test
  • Auth: API key in header Authorization

Path parameters

webhookIdstring required

The webhook's _id.

Request body

urlstring uri

Deliver this test to a different URL instead of the saved one. Must be https.

headersobject

Headers to send with this test delivery instead of the saved ones, as a flat string-to-string map.

event'pay' | 'authorize' | 'capture' | 'refund' | 'void' | 'reversal' | 'INITIATED' | 'IN_TRANSIT' | 'TRANSFERRED' | 'FAILED'

A single event type a webhook can be subscribed to. Six are transaction events (pay, authorize, capture, refund, void, reversal) and four are transfer status events (INITIATED, IN_TRANSIT, TRANSFERRED, FAILED). The casing is significant — the values are matched literally against the transaction operation or the transfer status that produced the event, so send them exactly as listed.

Response

The result of the test delivery.

successboolean

true if your endpoint returned a 2xx status.

statusCodeinteger

HTTP status your endpoint returned.

responseBodystring

A truncated snippet of your endpoint's response body.

latencyMsinteger

Round-trip time for the test delivery, in milliseconds.

Changes

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