Example of shipment webhook payload.
This operation describes the payload for shipment that our service will send to your webhook endpoint. <p>Note: The actual webhook URL is defined by you and is not part of our API domain. Please provide your endpoint URL when registering your webhook, along with supported Authentication Methods as described in Webhook Guide.</p> </p> Ensure that your endpoint is properly configured to handle the payloads and respond with the appropriate HTTP status codes. <ul> <li>Webhook Retry Logic</li> <li>Webhook Recommendations</li></ul></p>
Request
- Base URLhttps://webhook.example.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Your webhook path specified when creating your webhook configuration in the "url" field: e.g., url = "https://{webhook_base_url}/{webhook_endpoint_path}" (Create or update a push configuration.).
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.