Getting Started with Streams API

Start creating your routes using CommPeak Streams.

Start Creating Your First Route Using CommPeak Streams

Once you've made your choice, you can start creating your first route using CommPeak Streams API:

Click Streams API in the main menu on the left.
On the page that opens, click Create Streams API.

Create Streams API button
Choose a stream type.
Depending on your choice, perform the steps described in the dedicated articles:

Stream type options

Streams API Page

Click Streams API in the main menu on the left to open the Streams API page. It lists all SMS streams that you have created and their total amount.

To define your search, apply name, status, or tag filters at the top.

Screenshot of the Streams API page — **Streams API** page

Scroll between the pages by clicking the navigation links in the bottom right corner.

Screenshot of the **Streams API** page navigation — **Streams API** page navigation

The following table contains column explanations.

Column	Description
Name	A stream name combines any letters, numbers, or symbols. Click on the name to open a side panel with the following tabs: - Info - edit stream details and view statistics (all stream types) - Settings - change settings for the OTP code and limits for sending messages (OTP) - Events - create a new event template (OTP and Transactional) - WhatsApp - view settings and templates and update the token (WhatsApp) - Webhooks - view Webhook data, copy the endpoint and request body (WhatsApp and two-way) - Request API - copy API endpoint and request body(all stream types) For more details, please take a look at the sections below.
Status	- Ready - the stream is prepared for use - Sending - SMS messages are currently being sent - Draft - some stream creation steps haven't been completed - Disabled - you have manually paused the stream
Tags	Tags that you applied to the stream in the first step of its creation
Type	Marketing, Transactional, OTP, Two-way, or WhatsApp
Allowed IPs	One or more IP addresses that you allowed to make API calls
Last Activity
Action	Click the three-dot menu to perform the following actions: - Show token - click to copy an API token - Test stream API - send a test message - Edit stream - modify stream details and settings - Reset token - generate a new API token - Disable - temporarily deactivate - Restrict - - Delete - remove from the platform.

Streams API Data

After you click the stream name in the table on the Streams API page, a side panel opens on the right. It contains the following tabs, each with additional settings depending on the stream type.