APG PayAPG Paydocs

Webhooks

Get webhook

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

Return one webhook subscription. The signing secret is never included.

Permissions

Required permission
webhookSubscriptions:query

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

Path parameters

webhookIdstring
required

Responses

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

Discriminated by type
type = "WebhookViewAttributes"
webhookIdWebhookIdrequired

Identifier of a webhook subscription.

Example webhook_9f2Kd8QpLzXw

merchantIdMchtId

The merchant whose events this delivers. Absent for a marketplace-wide subscription.

Example mcht_9f2Kd8QpLzXw

marketplaceIdMktpId

The marketplace whose events this delivers.

Example mktp_9f2Kd8QpLzXw

urlstringrequired

Example https://example.com/callback

statusWebhookStatusrequired
ActiveSuspendedUnknown
eventsarray of WebhookEventType

The event types delivered.

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

descriptionstring

What this subscription is for, in your own words.

metadatamap of any JSON value

Free-form data the platform stores and returns untouched.

readablebooleanrequired

Whether the caller may read this subscription's detail. A subscription can be *listed* by a principal that may not see the endpoint it delivers to.

Example true

consecutiveFailuresinteger (int32)required

How many deliveries created since the newest one your endpoint accepted are Failed or Abandoned; every such delivery when none was ever accepted, and 0 when there are none. Counted by when each delivery was created, so redelivering an old failure that then succeeds does not reset it. The platform does not suspend a subscription on its own, however high this goes.

Example 1250

lastDeliveryAtstring (date-time)

When we most recently tried to deliver anything to this subscription. Absent until the first attempt.

Example 2026-08-19T04:21:07Z

lastDeliveryStatusWebhookDeliveryStatus

The status of this subscription's newest delivery. Absent when it has none.

PendingPendingRetryDeliveredFailedAbandonedObservedUnknown
createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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"
}

Error responses