Skip to main content

​
Overview

Manually triggers a retry for a webhook delivery that is in FAILED status. This resets the delivery to PENDING and schedules an immediate dispatch attempt.

​
Endpoint

POST /partners/webhooks/deliveries/:id/retry

​
Authentication

Requires a valid API Key with the partner_webhooks_manage permission.

​
Path Parameters

ParameterTypeRequiredDescription
idUUIDYesThe delivery ID (from GET /partners/webhooks/deliveries).

​
Example Request

curl -X POST "https://apiv3.thecleanlife.dev/v1/partners/webhooks/deliveries/jjjjjjjj-0000-0000-0000-000000000002/retry" \
  -H "x-api-key: YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK 
{
  "success": true,
  "data": {
    "id": "jjjjjjjj-0000-0000-0000-000000000002",
    "status": "PENDING"
  }
}

​
Error Responses

HTTP StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENMissing partner_webhooks_manage permission
404RESOURCE_NOT_FOUNDDelivery not found, or delivery belongs to a different partner
404DELIVERY_NOT_RETRYABLEDelivery is not in FAILED status (cannot retry PENDING or DELIVERED deliveries)

​
Notes

  • Only FAILED deliveries can be manually retried.
  • After calling this endpoint, the delivery status changes to PENDING. The system will attempt dispatch immediately.
  • The error field is cleared when a retry is initiated. If the retry fails, it will be set again.
  • There is no limit on the number of manual retries.
  • The delivery’s attemptCount continues to increment with each retry.
  • GET /partners/webhooks/deliveries — List deliveries and find FAILED ones