Skip to main content
GET
/
api
/
partner
/
v2
/
webhook-notifications
/
{id}
Get webhook notification details
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id} \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {
    "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
    "status": "FAILED",
    "retryAttempts": 5,
    "manualRetryCount": 1,
    "payload": {
      "type": "TRANSACTION",
      "event": "CREATED_ON_RAMP",
      "externalUserId": "18c54df0-1e62-4fee-8864-9b7512a0748c",
      "transactionId": "14f6ba28-d285-4658-8dd7-8a1d903838c8",
      "firstName": "Martin",
      "lastName": "Smith"
    },
    "latestErrorPayload": {
      "success": false,
      "error": {
        "message": "Token \"2a7db920-1987-451f-9888-9262dc0f2e22\" not found",
        "id": ""
      }
    },
    "lastManualRetryAt": "2026-01-15T10:35:00.000Z",
    "version": 1,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T10:35:00.000Z"
  }
}
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

  • latestErrorPayload: Contains the error body returned by your endpoint on the last failed delivery attempt. Use this to diagnose why delivery failed (e.g. a 500 from your server).
  • retryAttempts: The number of automatic delivery attempts made by Capa. After the maximum is reached, 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

StatusDescription
PENDINGQueued for delivery or currently being retried
SENTSuccessfully delivered to your endpoint
FAILEDAll automatic delivery attempts exhausted
NOT_SENTNo webhook URL was configured at the time of the event

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
404NOT_FOUND”Webhook notification not found”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is 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