APG PayAPG Paydocs

Webhooks

List webhooks

GET/webhooks
Request
GEThttps://api.tst.au.apgpay.dev/webhooks
curl -X GET https://api.tst.au.apgpay.dev/webhooks \
  -H "Authorization: Bearer $API_KEY"

Return a page of webhook subscriptions. Supply page for offset pagination or startingAfter for cursor pagination, and q to search. A caller held to no merchant or marketplace, and not entitled to every subscription, reads only those its merchantId or marketplaceId names. GET /filter-catalogues/webhooks lists the filters this caller can use. A cursor continues only the walk that issued it: sent with different filters, q or sort, it is refused with 400.

Permissions

Required permission
webhookSubscriptions:query

Requires the `query` action on `webhookSubscriptions` for the supplied runtime context

Query parameters

qstring

Search. Matches a webhook id, the URL or the description, or any part of the name of an event type it is subscribed to. An id, an email address, a phone number and any value listed as matched exactly match exactly; any other term matches without regard to case from the start of a value (or of any word in it, beside a longer word of the term), or anywhere in it from three characters, every word of it somewhere; a term that matches nothing so is read again with typos tolerated. Closest matches come first unless sort is given.

pageinteger (int32)

Offset pagination: 1-based page number. Mutually exclusive with the cursor parameters.

startingAfterstring

Cursor pagination, moving forward: the id of the last item on the current page. Mutually exclusive with page.

endingBeforestring

Cursor pagination, moving backward: the id of the first item on the current page. Mutually exclusive with page.

limitinteger (int32)

Maximum items per page.

sortarray of WebhookSort

Fields to sort by, comma-delimited, in priority order. Prefix a field with - for descending.

columnsarray of WebhookColumn

Columns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.

statusone of WebhookStatus, array of WebhookStatus

Only subscriptions whose status is one of these. Repeat the parameter to give several.

statusNotone of WebhookStatus, array of WebhookStatus

Leave out subscriptions whose status is one of these. Repeat the parameter to give several.

merchantIdone of array of string, string

Only subscriptions whose merchant is one of these. Repeat the parameter to give several.

merchantIdNotone of array of string, string

Leave out subscriptions whose merchant is one of these. Repeat the parameter to give several.

marketplaceIdone of array of string, string

Only subscriptions whose marketplace is one of these. Repeat the parameter to give several.

marketplaceIdNotone of array of string, string

Leave out subscriptions whose marketplace is one of these. Repeat the parameter to give several.

Responses

The response is a tagged shape: type is always "WebhookPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "WebhookPageAttributes"
hasMorebooleanrequired

Whether further items exist after this page.

Example true

nextStartingAfterstring

Id to pass as startingAfter to fetch the next page. Present in cursor mode only.

totalCountinteger (int64)

Total items matching the query.

Example 42

pageinteger (int32)

The 1-based page returned. Present in offset mode only.

Example 1250

totalPagesinteger (int32)

Total pages available. Present in offset mode only.

Example 1250

Example
{
  "type": "WebhookPageAttributes",
  "data": [
    {
      "type": "WebhookViewAttributes",
      "webhookId": "webhook_9f2Kd8QpLzXw",
      "merchantId": "mcht_9f2Kd8QpLzXw",
      "marketplaceId": "mktp_9f2Kd8QpLzXw",
      "url": "https://example.com/callback",
      "status": "Active",
      "events": [
        "MerchantCreated"
      ],
      "description": "string",
      "metadata": {
        "yourKey": {}
      },
      "readable": true,
      "consecutiveFailures": 1250,
      "lastDeliveryAt": "2026-08-19T04:21:07Z",
      "lastDeliveryStatus": "Pending",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses