1stream API

This article details the API options available in the 1stream platform

Updated at October 30th, 2024

1Stream Core Required

1stream Core Required

This feature is available for only 1stream Core licensed users and higher plans. If you don't have this and would like this feature to be available, please reach out to your Sales Representative to upgrade user licensing.

 

API Documentation

Our 1stream system offers a convenient JSON-based REST API for easy integration and also provides outbound webhooks for specific events.

Please reach out to our team at partners@bvoip.com to request the documentation, or if you're an active partner you can find it at Partners > Resources > Automation and APIs.

Creating API Keys

The following guide will provide step-by-step instructions on how to create API keys for authentication purposes in the REST API.

Creating Webhooks

For detailed instructions on how to create Webhooks that can send event data to an external HTTP endpoint, please refer to our document below.

API Fields

The document below covers the fields that are available via the various API Endpoints, with examples for reference. The most up to date information will always be found in our Postman documentation linked above.