Account

Send a test delivery

Sends a signed test event to the endpoint so you can verify your receiver and signature check before relying on real events.

Requires an API key belonging to a user account. Acts on the calling account's own data.

post/v1/me/webhooks/{endpointId}/test

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/me/webhooks/{endpointId}/test
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

endpointIdstring required

Webhook endpoint id

Response

Send a test delivery

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "delivered": true,
    "httpStatus": 200
  }
}

Changes

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