Send a test delivery

POST/api/v1/webhooks/:id/test

POSTs a sample post payload (with test: true and X-Webhook-Event: test) to the endpoint, signed with its secret, and reports what your server answered. Updates last_delivery_at and last_error like a real delivery.

Request

Path parameters

idstring

Webhook id.

Response

Returns a JSON object with a data field containing the result.

Response fields

okboolean

true when your endpoint answered 2xx within 10 seconds.

statusnumber | null

The HTTP status your endpoint returned, null when unreachable.

errorstring | null

Why it failed, if it did.

curl -X POST https://redship.io/api/v1/webhooks/8d1f…/test \
-H "Authorization: Bearer rsp_your_key"

Success response200

{ "ok": true, "status": 200, "error": null }