Skip to main content
GET
/
api
/
v1
/
csp
/
webhook
List Webhooks
curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'x-partner-id: <x-partner-id>'
{
  "data": {
    "count": 1,
    "webhooks": [
      {
        "description": "Webhook to consume link events",
        "endpoint": "https://www.postb.in/1743272420303-9920796800870",
        "enabled": false,
        "events": [
          {
            "record_type": "RT_PaymentSubmissions",
            "event_type": "EK_Created"
          },
          {
            "record_type": "RT_PaymentSubmissions",
            "event_type": "EK_Updated"
          }
        ],
        "name": "Link Events",
        "secret": "2ff46f215a5bb7da8f7fda9b2b0c9ef86c9e7de6"
      }
    ]
  },
  "ok": true
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.paylias.xyz/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-partner-id
string
default:""
required

The Partner ID header used for authorization

Query Parameters

​
tokens
string
Example:

"whk_cjf0qavsemvkg2on8f8g"

​
endpoints
string
Example:

"https://api.stripe.com/webhook/link-events"

​
names
string
Example:

"Events"

​
enabled
boolean
Example:

true

​
limit
string
Example:

"3"

​
page
string
Example:

"1"

Response

Response when retrieving a list of webhook subscriptions

Standard response structure for successful operations

​
ok
boolean

Indicates if the operation was successful

Example:

true

​
data
object

Contains the response data