Skip to main content
PATCH
Update webhook endpoint

Headers

api-key
string
required
Example:

"secret_live_xxx"

Path Parameters

id
string
required

Webhook endpoint id (wh_end_…).

Example:

"wh_end_xxx"

Body

application/json
url
string<uri>
name
string
Maximum string length: 120
enabled
boolean
event_types
enum<string>[]
Minimum array length: 1

InkLink webhook event type (KYC or Web inquiry result status).

Available options:
kyc.result.pending,
kyc.result.manual_review,
kyc.result.approved,
kyc.result.rejected,
kyc.result.failed,
web.result.pending,
web.result.manual_review,
web.result.approved,
web.result.rejected,
web.result.failed

Response

Updated endpoint.

Webhook endpoint without signing secret.

id
string

Endpoint id (wh_end_…).

name
string | null
url
string<uri>
enabled
boolean
event_types
enum<string>[]

InkLink webhook event type (KYC or Web inquiry result status).

Available options:
kyc.result.pending,
kyc.result.manual_review,
kyc.result.approved,
kyc.result.rejected,
kyc.result.failed,
web.result.pending,
web.result.manual_review,
web.result.approved,
web.result.rejected,
web.result.failed
created_at
string<date-time>
updated_at
string<date-time>