Skip to main content
GET
/
webhook
/
endpoints
List Webhook Endpoints
curl --request GET \
  --url https://uat-api.clinkbill.com/api/webhook/endpoints \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "total": 1,
  "rows": [
    {
      "id": "whk_xxxxx",
      "url": "https://example.com/api/clink/webhook",
      "events": [
        "session.complete",
        "order.succeeded"
      ],
      "enabled": true,
      "signingSecret": "whsec_xxxxx",
      "maskedSigningSecret": "whsec_...abcd",
      "description": "Created through the API",
      "createdAt": 1782112780956,
      "updatedAt": 1782113780956
    }
  ],
  "code": 200,
  "msg": "Success"
}

Authorizations

​
X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

​
X-Timestamp
string
header
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Query Parameters

​
pageNum
integer<int32>
default:1

Current page number. Defaults to 1.

​
pageSize
integer<int32>
default:20

Page size. Defaults to 20. The maximum is 100; larger values are capped at 100.

Required range: x <= 100
​
enabled
boolean

Filter by endpoint status.

​
url
string<uri>

Filter by exact endpoint URL.

Response

Webhook endpoints retrieved successfully

Table Paging Data Object

​
total
integer<int64>

Total number of records

Example:

1

​
rows
object[]

List of webhook endpoints

​
code
integer<int32>

Response status code, 200 when success

Example:

200

​
msg
string

Brief description of what happened, 'success' when happy case

Example:

"Success"