Sign in

v1

latestOpenAPI 3.0.12026-07-243902.3 MB
Webhooks

Claim Status Webhook

Webhook endpoint documentation for claim status change notifications. This endpoint represents the structure of webhook payloads sent to your configured webhook URL when claim statuses change.

post/webhooks/claims

Request body

contractIdstring

Contract identifier

orderIdstring

Order identifier

claimIdstring required

Unique claim identifier

claimType'extended_warranty' | 'shipping_protection' | 'category' | 'shipping_resolution' | 'return_resolution' | 'exchange_resolution' required

Type of claim

claimStatus'approved' | 'denied' | 'review' | 'pending_adjudication' | 'fulfilled' | 'closed' required

Status of a claim

transactionIdstring required

Transaction identifier

remainingLimitOfLiabilitynumber

Remaining limit of liability on the entitlement

validationReasonstring

Reason for validation if claim is in review

reportedAtinteger required

When the claim was reported (Unix timestamp)

sendDateinteger required

When the webhook was sent (Unix timestamp)

type'claim_approved' | 'claim_denied' | 'claim_in_review' required

Type of webhook event

urlstring uri required

Webhook URL where this payload was sent

kidstring required

Key ID used for webhook signature verification

denialReason'occurred_outside_coverage' | 'failure_not_covered' | 'police_report_not_provided' | 'images_not_provided' | 'under_manufacturer_warranty' | 'fraud_risk' | 'identity_verification_failed'

Reason for claim denial

Example request

{
  "products": [
    {
      "limitOfLiability": {
        "currencyCode": "USD"
      },
      "components": [
        {
          "value": {
            "currencyCode": "USD"
          }
        }
      ]
    }
  ]
}

Response

Webhook received and processed successfully