POSTAPI key

Send a test delivery

POSTapi.freightratesmcp.com/v1/webhooks/{id}/test

Queue a ping delivery so you can prove your receiver end to end. It travels the same path as a real event: same headers, same envelope, same signature, same retry ladder. Write, so it needs the freightrates entitlement. The response confirms the delivery was queued, not that it arrived, and the queue is swept every 30 seconds. Answers 404 not_found for an unknown id.

Path parameters

idstringrequired

Endpoint id.

Response schema

3 fields

Derived from the example response, nested as the JSON is.

dataobject

The payload. Everything an endpoint returns sits under this key.

idstring

Stable identifier for the record. On the tracking endpoints this is the container UUID, except on a portfolio summary row, where it is the container number.

test_queuedboolean

True when the test event was accepted for delivery. It confirms the queue took it, not that your endpoint answered.

curl -X POST 'https://api.freightratesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10/test' \
  -H "Authorization: Bearer tmcp_YOUR_API_KEY"

const res = await fetch("https://api.freightratesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10/test", {
  method: "POST",
  headers: {
    "Authorization": "Bearer tmcp_YOUR_API_KEY"
  }
});
const data = await res.json();

import requests

res = requests.post(
    "https://api.freightratesmcp.com/v1/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10/test",
    headers={"Authorization": "Bearer tmcp_YOUR_API_KEY"},
)
data = res.json()

Response

{
  "data": { "id": "3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10", "test_queued": true }
}