Send a test delivery to a webhook

POST/webhooks/{webhookID}/test

Sends a sample event to the webhook's target URL so you can verify signature validation and connectivity, and returns the delivery result.

Auth:Bearer

Path parameters

webhookID

uuidrequired

Response

id

Unique identifier for this resource.

uuid

webhook_id

Identifier of the webhook.

uuid

event

Event type that triggered this delivery (e.g. `policy.updated`).

string

payload

The event payload delivered to the endpoint, matching the webhook event schema.

object

response_code

HTTP status code returned by the subscriber endpoint; null if unreachable.

integernull

success

Whether the delivery received a 2xx response from the subscriber.

boolean

attempts

Number of delivery attempts made so far, including retries.

integer

next_retry_at

RFC 3339 timestamp.

datetime

created_at

RFC 3339 timestamp of when the resource was created.

datetime

Request

bash

curl -sS -X POST "https://phosra-api-sandbox-production.up.railway.app/api/v1/webhooks/8a1b2c3d-4e5f-4a6b-9c8d-1e2f3a4b5c6d/test" \
  -H "Authorization: Bearer $PHOSRA_API_KEY"

Response

json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "webhook_id": "550e8400-e29b-41d4-a716-446655440000",
  "event": "string",
  "payload": {},
  "response_code": null,
  "success": true,
  "attempts": 0,
  "next_retry_at": null,
  "created_at": "2025-01-15T09:30:00Z"
}