PaygateDeveloper documentation

List Webhook Sinks

GET/api/v1/test/webhooks/sinks
operationId
testkit.ListWebhookSinks
Permission
read

Parameters

FieldinTypeRequiredDescription
cursorquerystring
limitqueryinteger
PG-Versionheaderstring

Responses

200 OK

ListEnvelope_WebhookSink

Response headers: `X-Request-Id`

FieldTypeRequiredDescription
dataWebhookSink[]
has_moreboolean
next_cursorstring | null
{
  "data": [
    {
      "created_at": "2026-10-01T09:00:00Z",
      "fail_count": 0,
      "id": "string",
      "mode": "string",
      "name": "string",
      "received_count": 0,
      "respond_status": 0,
      "updated_at": "2026-10-01T09:00:00Z",
      "url": "string"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

default Error

Problem

FieldTypeRequiredDescription
codestringYes
detailstring
detailsobject
errorsobject[]
errors.codestring
errors.fieldstring
errors.messagestring
instancestring
statusintegerYes
titlestringYes
typestring
{
  "code": "string",
  "detail": "string",
  "details": {},
  "errors": [
    {
      "code": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "instance": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

Errors

Derived from the modules this operation touches, because the snapshot carries no x-errors list yet — it may list codes this operation cannot return.

CodeStatus
testkit.seed_limit—
testkit.unavailable—
testkit.not_in_live404
testkit.not_simulatable409
testkit.advance_out_of_range422
testkit.demo_failed422
testkit.invalid_profile422
testkit.unknown_job_kind422

Try it

GET/test/webhooks/sinks

Makes a real call in test mode with your own key. The key stays in this tab and is never sent anywhere but the API.

No API base URL is configured for this environment, so try-it is unavailable.

Starts with pg_test_. A live key is refused before any request is made.

curl -X GET '<API_BASE_URL>/api/v1/test/webhooks/sinks' \
  -H 'Authorization: Bearer pg_test_…' \
  -H 'PG-Version: 2026-10-01'