Send test webhook

Endpoint: POST /api/v1/webhooks/{id}/test

Availability: Live in production.

Authentication: API key in Authorization: Bearer <key> with the write scope.

Send a test.ping event to the webhook endpoint to verify it is reachable and correctly validating signatures. The endpoint URL is validated for SSRF before delivery; URLs resolving to private IP ranges return an error. Test deliveries are not retried. Requires a plan with webhooks and an API key with write scope.

Parameters

• id (path, required): Webhook endpoint ID

Example request

curl -X POST "https://backworkhealth.com/api/v1/webhooks/YOUR_ID/test" \
  -H "Authorization: Bearer $BACKWORK_API_KEY"

Example response (200)

{
  "success": true,
  "data": {
    "delivery_id": 0,
    "endpoint_id": 0,
    "event": "test.ping",
    "http_status": 0,
    "success": true,
    "error": "string",
    "created_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

curl -X POST "https://example.com/webhooks/0/test"

{  "success": true,  "data": {    "delivery_id": 0,    "endpoint_id": 0,    "event": "test.ping",    "http_status": 0,    "success": true,    "error": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "meta": {    "request_id": "string",    "timestamp": "2019-08-24T14:15:22Z"  }}

Last updated on