Search for answers to common problems and get support from our team.

Support Menu

Contact Support

Return Webhook

Return Webhook

Overview

This API documentation provides details about the Route Return Webhook, which handles three topics:

  • return.created
  • return.updated
  • label.scanned

These webhooks notify you about newly created or updated return requests. The payload structure and related models are outlined below.

Webhook Payload

Description

The webhook payload provides information about return events sent from Route. Below is the structure of the payload:

{
  "url": "https://example.com/webhook-endpoint",
  "data": {
    "topic": "TOPIC",
    "data": DATA
  },
  "headers": {
    "Frate-Signature-Hmac-Sha256": "HMAC_SIGNATURE_FOR_YOU_TO_VERIFY"
  },
  "timeout": 5000
}

 

Headers

  Header Name Description
Frate-Signature-Hmac-Sha256 HMAC signature for verifying the authenticity of the webhook payload.

data Field

  Field Description
topic The event topic (return.created or return.updated).
data Serialized data corresponding to the ReturnGroupSerializer (either V1 or V2)

Refer to the ReturnGroupSerializer model below for details about the data field.

V2

Click here for the schema of ReturnGroupSerializer V2

V1 (legacy)

Click here for the schema of ReturnGroupSerializer V1

 

All accounts created after July 7th 2025 are on V2 by default

 

Related Links