Skip to main content
WEBHOOK

Body

application/json
​
topic
string
required

Webhook type

Example:

"return.processing"

​
trigger
string
required

Event that triggered the webhook. Only return.processing.failed is emitted.

Example:

"return.processing.failed"

​
return_id
integer
required

Loop return ID

Example:

1673

​
return_state
string
required

Loop return state at the time of the failure. The return usually remains open or review if processing failed.

Examples:

"open"

"review"

​
message
string | null
required

Failure description. Can be generic (for example, "Something went wrong during processing") or null.

Examples:

"Return failed to process"

null

​
source
string | null
required

System that started processing, or null when unknown

Examples:

"warehouse"

"admin"

"api"

null

Response

200

Return a 200 status to indicate that the data was received successfully