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
}

GET

api

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
}

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

boolean

Indicates if the operation was successful

Example:

true

data

object

Contains the response data

Show child attributes

data.count

integer

Total number of webhooks

Example:

2

data.webhooks

object[]

List of webhooks subscription objects

Show child attributes

data.webhooks.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.webhooks.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.webhooks.description

string

Description of the webhook

Example:

"Payment notifications"

data.webhooks.enabled

boolean

Whether the webhook is enabled

Example:

true

data.webhooks.endpoint

string

Endpoint URL of the webhook

Example:

"https://example.com/webhook"

data.webhooks.events

object[]

List of events the webhook subscribes to

Show child attributes

data.webhooks.events.created_at

object

A timestamp with seconds since epoch

Show child attributes

data.webhooks.events.created_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.webhooks.events.token

string

Event identifier token

Example:

"evt_123456789"

data.webhooks.events.record_type

enum<string>

Type of record for the event

Available options:

RT_PaymentSubmissions,

RT_Error,

RT_Payments,

RT_PaymentAdmissions,

RT_PaymentAdmissionTasks,

RT_Transactions

Example:

"RT_PaymentSubmissions"

data.webhooks.events.event_type

enum<string>

Type of event

Available options:

EK_Created,

EK_Updated

Example:

"EK_Created"

data.webhooks.events.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.webhooks.events.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

data.webhooks.events.webhook_id

string

Webhook identifier

Example:

"whk_123456789"

data.webhooks.name

string

Name of the webhook

Example:

"Payment Webhook"

data.webhooks.partner_id

string

Partner identifier

Example:

"part_123456789"

data.webhooks.secret

string

Secret for webhook signature verification

Example:

"whsec_123456789"

data.webhooks.token

string

Webhook identifier token

Example:

"whk_123456789"

data.webhooks.updated_at

object

A timestamp with seconds since epoch

Show child attributes

data.webhooks.updated_at.seconds

number<int64>

Time in seconds since epoch

Example:

1691831179

Complete Validation Create Webhook

⌘I

API documentation

Authorizations

Headers

Query Parameters

Response