Skip to content
Cipay
Esc
↑↓navigate↵open⌘Jpreview

Replay a Webhook Delivery

POST/v2/webhook-endpoints/{id}/deliveries/{deliveryId}/replay
Authorization
AuthorizationBearer token · headerrequired
Merchant API key scoped to one merchant and environment. Read operations require api:read, normal write operations require api:write, and broadcast mutations also require explicit broadcasts:write.
Path parameters
idstring<uuid>required
deliveryIdstring<uuid>required
Header parameters
idempotency-keystringrequired
Required for write endpoints that create records and need deterministic retry behavior.
min length 1 · max length 255
if-matchstringrequired
Strong entity revision ETag returned by the latest read or write.
matches ^\"[0-9]+\"$
x-request-idstring
Optional caller-provided request correlation ID.
min length 1
Responses
200OK
deliveryobjectrequired
Show properties
idstring<uuid>required
eventIdstring<uuid>required
eventScopestringrequired
Allowed:organizationcommerce
endpointIdstring<uuid>required
endpointScopestringrequired
Allowed:organizationsandboxproduction
merchantIdstring<uuid>required
environmentstring | anyrequired
Show properties
Any of:
string
string
any
any
statusstringrequired
Allowed:pendingprocessingsucceededfailed
attemptCountintegerrequired
min 0 · max 9007199254740991
lastAttemptAtstring<date-time> | anyrequired
Show properties
Any of:
string<date-time>
string<date-time>
any
any
lastResponseStatusCodeinteger | anyrequired
Show properties
Any of:
integer
integer
any
any
lastResponseSummarystring | anyrequired
Show properties
Any of:
string
string
any
any
lastFailureCodestring | anyrequired
Show properties
Any of:
string
string
any
any
succeededAtstring<date-time> | anyrequired
Show properties
Any of:
string<date-time>
string<date-time>
any
any
failedAtstring<date-time> | anyrequired
Show properties
Any of:
string<date-time>
string<date-time>
any
any
createdAtstring<date-time>required
updatedAtstring<date-time>required
400Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
401Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
403Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
404Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
409Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
422Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
429Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
500Standard Cipay error response.
errorobjectrequired
Show properties
codestringrequired
min length 1
messagestringrequired
min length 1
requestIdstringrequired
min length 1
detailsobject
Request
curl -X POST "https://api.cipay.net/v2/webhook-endpoints/%3Cuuid%3E/deliveries/%3Cuuid%3E/replay" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "idempotency-key: string" \
  -H "if-match: string"
Response
{
  "delivery": {
    "id": "<uuid>",
    "eventId": "<uuid>",
    "eventScope": "organization",
    "endpointId": "<uuid>",
    "endpointScope": "organization",
    "merchantId": "<uuid>",
    "environment": "sandbox",
    "status": "pending",
    "attemptCount": 0,
    "lastAttemptAt": "2024-01-01T00:00:00Z",
    "lastResponseStatusCode": 0,
    "lastResponseSummary": "string",
    "lastFailureCode": "string",
    "succeededAt": "2024-01-01T00:00:00Z",
    "failedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}