Since Postmark’s API and feature set has been growing, we decided it was time to rethink our approach to our documentation. We’re super excited to announce that we’ve completely redesigned our documentation from the ground up.
With the new documentation, we separated the tutorial or guide based content from the API reference. Our previous documentation was mixed, making it hard to quickly jump to an endpoint. Here is a list of the new sections:
User guides #
User guides provide a detailed walk through on accomplishing specific tasks with Postmark. This is perfect for those that are just getting started and need a guide on how to use specific features. Our current guides are:
API reference #
For those who rely on our REST API, we’ve separated all of those details into their own reference. Each HTTP request now has:
- A list of every expected parameter needed to use a specific request
- Expected data types for each request and response parameters
- An example curl request
Webhooks aren’t buried inside of a specific feature anymore. We’ve made these a lot more visible and provide everything you need to get started with Postmark’s webhooks. Our current webhooks are:
In the coming months we’ll be adding more guides and code samples. Our goal is to help our customers get started as fast as possible and to use some of the more advanced features in the service. We hope you like it!
This post was originally published Aug 22, 2014