Skip to main content
GET
/
webhooks
List all webhooks
curl --request GET \
  --url https://api.notchpay.co/webhooks \
  --header 'Authorization: <api-key>'
{
  "code": 200,
  "status": "OK",
  "message": "Webhook endpoints retrieved",
  "totals": 5,
  "last_page": 1,
  "current_page": 1,
  "selected": 5,
  "endpoints": [
    {
      "id": "wh_123456789",
      "url": "https://example.com/webhooks",
      "description": "Webhook principal",
      "events": [
        "payment.complete"
      ],
      "created_at": "2023-01-01T12:00:00.000Z",
      "updated_at": "2023-01-02T12:00:00.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer
default:30

Number of items per page

​
page
integer
default:1

Page number

Response

Webhook endpoints retrieved

​
code
integer
required
Example:

200

​
status
string
required
Example:

"OK"

​
message
string
required
Example:

"Webhook endpoints retrieved"

​
endpoints
any[]
required
​
totals
integer
Example:

5

​
last_page
integer
Example:

1

​
current_page
integer
Example:

1

​
selected
integer
Example:

5