Request IDs

Every response from the API has an X-Request-Id header. It names that one request in Postel's logs.

X-Request-Id: req_8f14e45fceea167a5a36dedd4bea2543

Error bodies carry the same value as requestId:

{
  "error": "Something went wrong on Postel's side. Try again in a minute.",
  "code": "server_error",
  "requestId": "req_8f14e45fceea167a5a36dedd4bea2543"
}

Send your own

If your system already has an id for the request, such as a trace id, send it as X-Request-Id and Postel uses it instead of making one. It can be up to 255 characters of letters, digits, _, - and =. Anything else is replaced with a new id.

Use it

• Log the request id with every failed request, next to the status and code.
• When something looks wrong, send the request id to contact@postel.app. With it, we can find what happened to that request.