Skip to main content

Explore Botanalytics APIs with Postman

When you're working on a custom integration with Botanalytics, odds are that you'll use our HTTP APIs. These APIs can be accessed programmatically but they can also be incredibly useful for manual debugging. This process of manual debugging can be very time-consuming though. To help developers interact with our Botanalytics APIs we've recently created a workspace on Postman that comes with all of our API endpoints pre-filled.

In this blog post, we'll explain what this will enable you to do.

What is Postman?

Postman is a platform that makes it very easy to communicate with APIs. It allows you to host workspaces that contain collections of pre-configured API endpoints in a convenient user interface. These workspaces are designed to be customizable. It’s very easy to re-use requests and to switch from a local deployment to a production environment.

How do I get started?

To get started, go to the Botanalytics workspace on Postman. When you go there, you should see an interface that looks like this:

Postman Botanalytics workspace look like this

This is the Botanalytics workspace. At the time of writing, it contains one API collection. This API can be explored and you can use the predefined endpoints to make a request. There are five channel request examples here in this collection and different message type payloads.


The screenshot below shows an example of a request going to the /messages endpoint.

Messages endpoint example request

One of the best features of Postman is that it allows you to change pre-defined variables, such as the api-host variable. Since all the API definitions make use of this variable, you can switch between deployments with a single click.

Globals environment

You’re able to use the Botanalytics workspace as a starting point to bootstrap custom environments to work from. This can be a convenient way to separate the production from the development environment.

Also, this is where you could set api-authentication-token environment variable which is used for authorization of the requests on our end for /messages endpoint REST API. It's a JWT token provided when you add a channel to your project.

Universal channel environment

Try it out!

Feel free to give the Botanalytics workspace on Postman. a try! Checkout out the Botanalytics Postman documentation. We hope it makes it easier to explore the Botanalytics REST API and we’re also keen to hear any feedback that you might have on our feedback forum.

Happy hacking!