Skip to main content
POST
/
api
/
partner
/
v2
/
webhook-notifications
/
{id}
/
retry
Retry a failed webhook notification
curl --request POST \
  --url https://staging-api.capa.fi/api/partner/v2/webhook-notifications/{id}/retry \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {
    "id": "8374f327-38bd-4b0b-b8a7-2524599eb903",
    "status": "PENDING",
    "retryAttempts": 0,
    "manualRetryCount": 2,
    "payload": {
      "type": "TRANSACTION",
      "event": "CREATED_ON_RAMP",
      "externalUserId": "18c54df0-1e62-4fee-8864-9b7512a0748c",
      "transactionId": "14f6ba28-d285-4658-8dd7-8a1d903838c8",
      "firstName": "Martin",
      "lastName": "Smith"
    },
    "latestErrorPayload": null,
    "lastManualRetryAt": "2026-01-15T10:40:00.000Z",
    "version": 2,
    "createdAt": "2026-01-15T10:30:00.000Z",
    "updatedAt": "2026-01-15T10:40:00.000Z"
  }
}
Manually retries a FAILED webhook notification, queuing it for immediate re-delivery to your configured webhook URL. The automatic retry cycle is reset and manualRetryCount is incremented.

​
Important Notes

  • Status requirement: The notification must be in FAILED status. Attempting to retry a SENT, PENDING, or NOT_SENT notification returns a 409.
  • Manual retry limit: Each notification allows a maximum of 3 manual retries. Once reached, the endpoint returns 409 and the notification cannot be retried again.
  • Rate limit: A maximum of 10 manual retries per partner per minute is enforced. Exceeding this returns 429.
  • Automatic retry reset: On a successful retry request, retryAttempts is reset to 0 and latestErrorPayload is cleared, giving the notification a fresh delivery cycle.

​
When to Retry vs. When to Contact Support

Retry when:
  • Your endpoint was temporarily unavailable (e.g. a deployment, a transient 5xx).
  • You fixed a bug in your webhook handler and need the event reprocessed.
  • The latestErrorPayload shows a recoverable error (connection timeout, 503, etc.).
Contact support when:
  • Your webhook URL has changed — update it first via PUT /api/partner/v2/webhook-settings, then retry.
  • The event payload is stale and the corresponding transaction has already been handled through another channel.
  • You have exhausted all 3 manual retries and still cannot receive the notification.

​
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”
409CONFLICT”Notification is not in FAILED status”
409CONFLICT”Partner webhook notification has reached the maximum number of manual retries (3)“
429TOO_MANY_REQUESTS”Rate limit exceeded. Try again in a few seconds.”

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 to retry

Example:

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

Response

Notification successfully queued for re-delivery. Returns the updated notification with status reset to PENDING.

​
success
boolean
Example:

true

​
data
object