Test a Webhook Endpoint

Send a simulated tracking event to your registered webhooks

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Send a simulated tracking event to the webhook URLs registered in your account so you can verify that your integration receives and processes tracking status updates correctly.

When to use:
Call this endpoint during development to test your webhook handler before going to production. It triggers a test POST to every active webhook URL configured in your account — no URL is passed in the request body.

Prerequisites:

  • Valid JWT authentication token (Bearer)
  • At least one active webhook URL registered in your account — webhooks are configured exclusively through the Envia platform UI at Settings → Developers → Webhooks (shipping.envia.com/settings/developers); there is no API endpoint to register or manage webhook URLs
  • A valid tracking number from a shipment already generated in your account (the shipment must belong to the authenticated company)

Webhook types available in the platform:

TypeDescription
onShipmentStatusUpdateTriggered on any shipment status change
statusUpdateWithEcommerceInfoStatus change with e-commerce order details
simpleTrackingLightweight tracking event notification
ecommerceTrackingTracking event with e-commerce context
surchargeTriggered when a surcharge is applied to a shipment

Key behaviors:

  • Sends a test POST request to each active webhook URL registered in your account — the URL is not a parameter you pass in the request
  • The test payload format matches real production webhooks: { "carrier": "...", "tracking_number": "...", "shipment_status": "..." }
  • Returns error code 1125 with message "The company has not webhooks configured" if the account has no active webhooks
  • In non-production environments, also updates the shipment's status record in the database
  • Use this to validate your webhook handler logic, response codes, and error handling before going live
Body Params
string
required

Carrier name from the shipment (e.g. fedex, dhl, estafeta). Must match the carrier of the shipment associated with the provided tracking number.

string
required

Tracking number of a shipment previously generated in your account. The shipment must belong to the authenticated company.

string
enum
required

Status name to simulate. Accepted values: Delivered, Shipped, Canceled, Picked Up. These values also update the shipment's status record in non-production environments.

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json