Skip to main content
POST
Create webhook endpoint

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

Body

application/json

Webhook endpoint payload.

name
string
required
Example:

"Acme endpoint"

url
string
required
Example:

"https://acme.example/payfi/webhooks"

eventTypes
string[]
Example:

Response

Webhook endpoint created. The secret is returned only in this response.

webhookId
string
Example:

"whe_example"

name
string
Example:

"Acme endpoint"

url
string
Example:

"https://acme.example/payfi/webhooks"

status
string
Example:

"ACTIVE"

eventTypes
string[]
Example:
secretPreview
string
Example:

"whsec_te...abcd"

secret
string
Example:

"whsec_test_returned_once"

createdAt
string
Example:

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

updatedAt
string
Example:

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