APG PayAPG Paydocs

Webhooks

List webhook deliveries

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

Return a page of this subscription's deliveries, newest first. Filter by status to find the ones that did not arrive, and by event to follow one event type. Each entry carries the attempt count and the last HTTP status your endpoint answered with.

Permissions

Required permission
webhookSubscriptions:query

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

Path parameters

webhookIdstring
required

Query parameters

qstring

Search. Matches a delivery id, or exactly the event type, the id of the entity the event is about, the idempotency key or the request id. 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. Matches come newest 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 WebhookDeliverySort

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

statusstring

Filter to deliveries in one state. Failed is the one a dashboard usually wants.

eventWebhookEventType

Filter to one event type.

MerchantCreatedMerchantActivatedMerchantSuspendedMerchantAvailableBalanceUpdatedMerchantBankAccountAddedMerchantPrimaryBankAccountUpdatedPayPlanCreatedPayPlanActivatedPayPlanCompletedPayPlanInDefault
+27 more

PayInFullCreated, PayInFullAccepted, PayInFullAuthorised, PayInFullCompleted, TransactionPaid, TransactionFailed, DisputeCreated, DisputeUpdated, PayoutCreated, PayoutPending, PayoutFailed, PayoutPaid, PayoutReversed, InvoiceIssued, InvoiceDue, InvoicePaymentFailed, InvoicePaid, PaymentSourceCreated, PaymentSourceMethodUpdated, PaymentSourceDeleted, LoanCreated, LoanStatementCreated, LoanStatementIssued, LoanStatementDue, LoanStatementPaid, LoanPaymentFailed, Unknown

Responses

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

Discriminated by type
type = "WebhookDeliveryPageAttributes"
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": "WebhookDeliveryPageAttributes",
  "data": [
    {
      "type": "WebhookDeliveryViewAttributes",
      "webhookDeliveryId": "whdlv_9f2Kd8QpLzXw",
      "webhookId": "webhook_9f2Kd8QpLzXw",
      "event": "MerchantCreated",
      "status": "Pending",
      "attempts": 1250,
      "lastStatusCode": 1250,
      "lastError": "string",
      "lastAttemptAt": "2026-08-19T04:21:07Z",
      "lastSentTo": "string",
      "lastResponseBody": "string",
      "lastResponseHeaders": {
        "type": "WebhookResponseHeadersAttributes",
        "server": "string",
        "via": "string",
        "cfRay": "string",
        "amznRequestId": "string",
        "amznTraceId": "string",
        "requestId": "string",
        "cache": "string",
        "location": "string"
      },
      "deliveredAt": "2026-08-19T04:21:07Z",
      "idempotencyKey": "string",
      "eventPublishedAt": "2026-08-19T04:21:07Z",
      "createdAt": "2026-08-19T04:21:07Z",
      "updatedAt": "2026-08-19T04:21:07Z"
    }
  ],
  "hasMore": true,
  "nextStartingAfter": "string",
  "totalCount": 42,
  "page": 1250,
  "totalPages": 1250
}

Error responses