Update webhook delivery

PATCH/webhooks/{webhookId}/deliveries/{deliveryId}

Act on one delivery. Today the only action is to send it again. A delivery that does not belong to this webhook is a 404, not a redirect.

Permissions

Required permission

webhookSubscriptions:update

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

Path parameters

webhookIdstring

required

deliveryIdstring

required

Request body

This body is a tagged shape: type is always "WebhookDeliveryUpdRedeliver". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type

type = "WebhookDeliveryUpdRedeliver"

This variant has no additional fields.

curl -X PATCH https://api.tst.au.apgpay.dev/webhooks/{webhookId}/deliveries/{deliveryId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "WebhookDeliveryUpdRedeliver"
}'

Responses

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

Discriminated by type

type = "WebhookDeliveryUpdateRspAttributes"

The resource as it stands after the change.

typeenumrequired

WebhookDeliveryViewAttributes

webhookDeliveryIdWebhookDeliveryIdrequired

Identifier of one webhook delivery.

Example whdlv_9f2Kd8QpLzXw

webhookIdWebhookIdrequired

Identifier of a webhook subscription.

Example webhook_9f2Kd8QpLzXw

eventWebhookEventTyperequired

The event type 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

statusWebhookDeliveryStatusrequired

PendingPendingRetryDeliveredFailedAbandonedObservedUnknown

attemptsinteger (int32)required

How many times we have tried this delivery. Some attempts do not reach your endpoint at all, such as those made while the subscription is suspended; lastError says when that is why.

Example 1250

lastStatusCodeinteger (int32)

The HTTP status your endpoint answered with on the most recent attempt.

Example 1250

lastErrorstring

Why the most recent attempt did not succeed, when the reason was not an HTTP status, or what to do about a redirect, which is not followed: update the subscription url to its location.

lastAttemptAtstring (date-time)

When we most recently called your endpoint.

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

lastSentTostring

The url we most recently sent this to. It is read from the subscription at the moment of the call, so correcting the url and redelivering sends the same event to the new one.

lastResponseBodystring

The start of what your endpoint answered with on the most recent attempt, success included, cut at 500 bytes. Absent when that attempt got no answer or an empty one.

Who answered the most recent attempt, from the response headers that identify a server, CDN or firewall. Absent when that attempt got no answer, or an answer carrying none of them.

deliveredAtstring (date-time)

When your endpoint accepted it.

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

idempotencyKeystringrequired

The identity of this delivery, stable across retries and redeliveries. Use it to make your handler idempotent: the same key is the same event for the same subscription.

eventPublishedAtstring (date-time)required

When the event itself happened. Compare it with createdAt to see how long we took to pick the event up, and with lastAttemptAt for the whole journey.

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

createdAtstring (date-time)required

When we queued this delivery. Not when the event happened, which for a redelivery may be much earlier.

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

updatedAtstring (date-time)required

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

Example

{
  "type": "WebhookDeliveryUpdateRspAttributes",
  "updated": {
    "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"
  }
}

Error responses

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}

statusCodeinteger (int32)required

HTTP status code for this error

errorCodestringrequired

An APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.

messagestringrequired

Human readable description of the error

tracerstring

An unique identifier for the request. Provide this to the support team if you wish to query a particular error.

detailstring

Optional additional details for the error.

errorTypeDescriptionstring

A description of the category of errors for the given statusCode.

metadataobject

Optional key value list of metadata

Example response

{
  "statusCode": 100,
  "errorCode": "string",
  "message": "string",
  "tracer": "string",
  "detail": "string",
  "errorTypeDescription": "string"
}