Notice: This endpoint is the specification of how you shall implement your webhook handler for AfterShip Warranty, in case you want to receive updates and sync them into your own system.

Please note that you can define URLs freely. /your-webhook-receiver-endpoint is just an example. We accept all the URLs that are HTTPS protected. You can register your own base URL upon registration.

Request

Headers

as-signature-hmac-sha256

string

Webhook signature

Example:

QbuJUExfJz0NnRHlwRzX1UU2gZK+v3urueXYK67tdlA=

Body

string

event

string

version

string

created_at

string<date-time>

data

object

warranty

object

required

warranty_shipment

object

current_context

Claim

A claim resource.

string

note

string

approval_note

string or null

A note included when the claim was approved.

warranty_page

object

The warranty page from which the claim was submitted.

items

array[ClaimItem]

A claim item resource.

order

object

status

string

Allowed values:

under_reviewapprovedin_processcompletedrejectedcanceled

flow_type

string

Allowed values:

no_order_numberrequired_order_number

created_at

string<date-time>

The date and time, formatted in ISO 8601, when the claim was created.

Example:

2026-05-19T10:00:00Z

process_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim entered processing.

Example:

2026-05-19T10:00:00Z

rma_number

string

updated_at

string<date-time>

The date and time, formatted in ISO 8601, when the claim was last updated.

Example:

2026-05-19T10:00:00Z

approved_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim was approved.

Example:

2026-05-19T10:00:00Z

canceled_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim was canceled.

Example:

2026-05-19T10:00:00Z

rejected_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim was rejected.

Example:

2026-05-19T10:00:00Z

completed_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim was completed.

Example:

2026-05-19T10:00:00Z

shipping_address

Address

contact_email

string

organization

object

cancel_reason

string or null

A free-form reason describing why the claim was canceled.

reject_reason

string or null

A free-form reason describing why the claim was rejected.

dynamic_fields

object

inbound_shipments

array[ClaimShipment] or null

outbound_shipments

array[ClaimShipment] or null

receiving_status

string

Allowed values:

receivednot_received

Default:

not_received

received_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the returned item was marked as received.

Example:

2026-05-19T10:00:00Z

Parameters

Body

preparing...