Skip to main content
GET
/
api
/
v1
/
csp
/
webhook
/
{webhook_id}
/
events
List Events
curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/webhook/{webhook_id}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'x-partner-id: <x-partner-id>'
{
  "data": {
    "count": 1,
    "webhooks": [
      {
        "created_at": {
          "seconds": 1744270524
        },
        "delivery_attempts": 1,
        "endpoint_url": "https://www.postb.in/1743269295619-3870068176183",
        "event_kind": 1,
        "notification_id": "notif_cvrn9es20or7jl6nihfg",
        "payload": "eyJ0b2tlbiI6ImNqZXM3NnZzZW12ajNvYnNuYzU0IiwidmVyc2lvbiI6IjEuMC4wIiwiZXZlbnRfdHlwZSI6IkVLX0NyZWF0ZWQiLCJyZXNvdXJjZV90eXBlIjoiUlRfUGF5bWVudHMiLCJlbmRwb2ludCI6Imh0dHBzOi8vd3d3LnBvc3RiLmluLzE3NDMyNjkyOTU2MTktMzg3MDA2ODE3NjE4MyIsImRhdGEiOnsicGF5bWVudF9pZCI6ImNqZXM3NnZzZW12ajNvYnNuYzU0Iiwib3JnYW5pemF0aW9uX2lkIjoib3JnX2N0MjM5bjQyMG9yMjQ5azVibzkwIiwicGFydG5lcl9pZCI6InBhcnRfY3QyM2I2NDIwb3IyNDlrNWJvYWciLCJyZWZlcmVuY2UiOiJJTlYwMDAxIiwiaW5pdGlhdGVkX2F0IjoxNzQ0MjcwNTIzLCJleHBpcmVzX2F0IjoxNzQ0Mjc0MTIzLCJhbW91bnQiOnsiY3VycmVuY3kiOiJVU0QiLCJ0b3RhbCI6IjEwMDAwIn0sImRlYnRvcl9wYXJ0eSI6eyJwYXltZW50X2FkZHJlc3MiOiJqb2huQHN0cmlwZS1wbGF0aW51bSIsImZpcnN0X25hbWUiOiJKb2huIiwibGFzdF9uYW1lIjoiQ29sbGlzb24iLCJlbWFpbCI6ImpvaG5jQHN0cmlwZS5jb20iLCJwaG9uZSI6IisxNjQ2MjQ0Mjk0NSIsInR5cGUiOiJQYXllZV9JbmRpdmlkdWFsIiwiYmlsbGluZyI6eyJjb3VudHJ5IjoiVVMifX0sImJlbmVmaWNpYXJ5X3BhcnR5Ijp7InBheW1lbnRfYWRkcmVzcyI6InppeWFkQHNhZmVwYXktcGxhdGludW0iLCJmaXJzdF9uYW1lIjoiWml5YWQiLCJsYXN0X25hbWUiOiJQYXJla2giLCJlbWFpbCI6InppeWFkLnBhcmVraEBnbWFpbC5jb20iLCJwaG9uZSI6Iis5MjMwMDgyNzc4NzkiLCJ0eXBlIjoiUGF5ZWVfSW5kaXZpZHVhbCIsImJpbGxpbmciOnsiY291bnRyeSI6IlVTIn19LCJkZXZpY2UiOnt9LCJsb2NhdGlvbiI6e319LCJjcmVhdGVkX2F0Ijp7InNlY29uZHMiOjE3NDQyNzA1MjQsIm5hbm9zIjo1ODE0NjAwMH19",
        "record_type": 2,
        "signature": "c568b3bf6d1621e9d79f8b8db3d83e4c30053fa610f265e3fd61aa4f5e123b1e123e390b26fdc74c3ab15eaef00e56d79f4c1321461f1aa9e9fbe4f9a6d78a61",
        "status": 0,
        "token": "wh_cvrn9f420or7jl6nihg0",
        "updated_at": {
          "seconds": 1744270525
        },
        "webhook_id": "whk_cvk2qqs20or7iffvl200"
      }
    ]
  },
  "ok": true
}

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

Path Parameters

​
webhook_id
string
required

The unique identifier for the webhook

Example:

"whk_cjf0qivsemvkg2on8f9g"

Query Parameters

​
limit
string
Example:

"20"

​
page
string
Example:

"1"

​
delivery_status
enum<string>
Available options:
Undelivered,
Delivered
Example:

"Undelivered"

Response

Response when retrieving a list of events fired against a webhook subscription

Standard response structure for successful operations

​
ok
boolean

Indicates if the operation was successful

Example:

true

​
data
object

Contains the response data