Skip to main content
PATCH
/
v1
/
webhooks
/
{webhookId}
curl --request PATCH \ --url https://sandbox.payfi.global/v1/webhooks/{webhookId} \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: <api-key>' \ --header 'X-PayFi-Api-Key: <api-key>' \ --header 'X-PayFi-Nonce: <api-key>' \ --header 'X-PayFi-Signature: <api-key>' \ --data ' { "eventTypes": [ "operation.manual_review.completed" ], "rotateSecret": true } '
{
  "webhookId": "whe_example",
  "name": "Acme endpoint",
  "url": "https://acme.example/payfi/webhooks",
  "status": "ACTIVE",
  "eventTypes": [
    "operation.manual_review.completed"
  ],
  "secretPreview": "whsec_te...wxyz",
  "secret": "whsec_test_returned_once_on_rotation",
  "createdAt": "2026-05-20T12:00:00.000Z",
  "updatedAt": "2026-05-20T12:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.payfi.global/llms.txt

Use this file to discover all available pages before exploring further.

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 endpoint update payload.

​
name
string
Example:

"Acme endpoint"

​
url
string
Example:

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

​
status
enum<string>
Available options:
ACTIVE,
DISABLED
Example:

"ACTIVE"

​
eventTypes
string[]
Example:
["operation.manual_review.completed"]
​
rotateSecret
boolean
Example:

true

Response

Webhook endpoint updated.

​
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:
["operation.analysis.completed"]
​
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"