Skip to main content
POST

Authorizations

X-PayFi-Api-Key
string
header
required
X-PayFi-Nonce
string
header
required
X-PayFi-Signature
string
header
required
Idempotency-Key
string
header
required

Path Parameters

webhookId
string
required

Webhook endpoint ID.

Body

application/json

Webhook test options.

event
enum<string>
Available options:
operation.created,
operation.requirements.ready,
operation.documents.partial,
operation.analysis.completed,
operation.action_required,
operation.manual_review.completed,
operation.callback.failed
Example:

"operation.analysis.completed"

Response

Test delivery attempted.

webhookDeliveryId
string
Example:

"whd_example"

status
string
Example:

"DELIVERED"

responseStatus
number
Example:

204

attemptedAt
string
Example:

"2026-05-20T12:00:00.000Z"

samplePayload
object