Skip to main content
GET
Get webhook notification details
Retrieves the full details of a single webhook notification, including its original payload, delivery status, retry history, and the error response from the last failed attempt.
For an overview of webhook events and payload structures, see the Webhooks Guide.

Important Notes

  • id: The same value as the capa-delivery-id header of every delivery of this notification.
  • payload: Always present. Exactly the JSON body that was POSTed to your endpoint, with the same schema as the webhook events.
  • latestErrorPayload: null until a delivery attempt fails. Then it holds the body your endpoint returned with a non-2xx status (parsed JSON, or a string if it was not JSON), or { "error": "<message>" } when Capa could not reach your endpoint (timeout, DNS or connection error) or the URL was rejected by Capa’s outbound policy. It is cleared back to null when a delivery succeeds and when you request a manual retry. Use status to know whether the notification was delivered.
  • retryAttempts: The number of failed automatic delivery attempts in the current cycle. After 5, the status transitions to FAILED.
  • manualRetryCount: Incremented each time you call the retry endpoint. A maximum of 3 manual retries are allowed per notification.

Status Reference


Error Codes

These are the errors this endpoint returns most often. Branch on code, not message, and handle codes you don’t recognize by their HTTP status. See Error Codes for the complete list.

Common Errors

Endpoint-Specific Errors

Authorizations

partner-api-key
string
header
required

API key for the affiliated partner performing the request.

Path Parameters

id
string
required

The webhook notification ID

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

Response

Returns the full details of a single webhook notification including its payload and error information.

success
boolean
Example:

true

data
object