Skip to main content

REST API

PostMX exposes a public REST API for creating inboxes, listing messages, fetching full or reduced message detail, and registering webhook targets for email.received events.

Open the reference​

Authentication​

Use a bearer token issued from the PostMX dashboard:

Authorization: Bearer pmx_live_...

Base URL​

https://api.postmx.co

What the API covers​

  • GET /v1/inboxes
  • POST /v1/inboxes
  • GET /v1/inboxes/{inbox_id}/messages
  • GET /v1/messages
  • GET /v1/messages/{message_id}
  • POST /v1/webhooks

Webhook payloads​

When PostMX delivers a webhook, it sends a signed JSON POST request containing:

  • event metadata: id, type, created_at
  • data.inbox: inbox metadata
  • data.message: the full message payload, including otp, links, and intent

For the full delivery model, headers, signature flow, and processing guidance, read Verify Webhooks.

Good next steps​

  • Read the Node.js SDK if you want typed application code.
  • Read the Python SDK if you want async or sync Python integration.
  • Read the CLI docs if you want to work from a terminal or CI pipeline.