Skip to main content
POST
/
webhook
/
endpoints
Create webhook endpoint
curl --request POST \
  --url https://platform.inklink.com/api/v1/webhook/endpoints \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "enabled": true,
  "event_types": []
}
'
{
  "secret": "<string>",
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "enabled": true,
  "event_types": [],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
api-key
string
required
Example:

"secret_live_xxx"

Body

application/json
​
url
string<uri>
required

HTTPS URL that will receive POST webhook deliveries (HTTP allowed only in development on the server).

​
name
string

Optional label for your reference.

Maximum string length: 120
​
enabled
boolean

Defaults to true if omitted.

​
event_types
enum<string>[]

Event types to subscribe to. If omitted, the server defaults to all supported types.

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

Endpoint created. Body includes secret (whsec_…) exactly once.

Webhook endpoint without signing secret.

​
secret
string
required

Signing secret (whsec_ + base64). Shown only on create.

​
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>