API Reference

How to end-to-test test our API within our sandbox environment

🐛

Automated testing can drastically reduce bugs in development and in production

We offer a suite of end to end tests via a Postman Collection

We have exposed a set of internal tests here so that you can either manually test or automate tests within your own environment.

Using a shared means of testing ensures that we will not break your system if we push changes, and it also means that you can accurately assess the response for a given request payload to a given endpoint.

It is highly recommended that these tests are executed in an automated fashion whenever you push new changes to your production environment.

If automated testing isn't apart of your development practices, we still recommend manually using the provided Postman collection to ensure that you aren't rolling out breaking changes.