Skip to main content
POST
/
api
/
v2
/
webhook
/
list
List Webhooks
curl --request POST \
  --url https://api.paytring.com/api/v2/webhook/list \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'
{
  "status": true,
  "data": [
    {
      "id": "<string>",
      "url": "<string>",
      "topics": [
        "<string>"
      ],
      "status": "<string>",
      "created_at": "<string>"
    }
  ]
}
Fetch a list of all webhook endpoints associated with your merchant account.

​
Body Parameters

​
active
boolean
(Optional) Filter webhooks by status (true for active, false for inactive).

​
Response

​
status
boolean
Indicates if the request was successful.
​
data
array
List of webhook endpoints.

​
Sample Request

curl --location 'https://api.paytring.com/api/v2/webhook/list' \
--user '<API_KEY>:<API_SECRET>' \
--header 'Content-Type: application/json' \
--data '{
    "active": true
}'

​
Sample Response

{
    "status": true,
    "data": [
        {
            "id": "wh_12345",
            "url": "https://your-domain.com/webhook",
            "topics": ["order.paid", "order.failed"],
            "status": "active",
            "created_at": "2024-01-22T01:29:50Z"
        }
    ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
active
boolean

Filter webhooks by status (true for active, false for inactive).

Response

200 - application/json

Successful response

​
status
boolean
​
data
object[]