The Octave Developer Hub

Welcome to the Octave developer hub. You'll find comprehensive guides and documentation to help you start working with Octave as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Creating a Stream

Streams can be used to store data on the Cloud side via Cloud Actions.

User-created streams are useful when data needs to be stored on the Cloud side, often during a multi-step process (such as where one Cloud Action returns data to a Stream which is processed by another Cloud Action) or, a third-party system that injects data to trigger a Cloud Action using the Octave API.

📘

Note

The topic: Return updated device Cloud properties as Commands shows a use cases where Streams are used to store data on the Cloud side.

Before using Streams in a Cloud Action, you need to create them through the Octave Dashboard.

You can add your own Streams that can be written to and/or read from Cloud Actions.

Creating a new Stream

The following steps describe how to create a new Stream:

  1. Navigate to Cloud > Streams.
  2. Click Add Stream.
  3. Click on Path. Append the company name with a new Stream name. For example: /my_company/users/jsmith/my_stream.

📘

Tip

It's recommended that you create a meaningful name for your Stream that allows you to easily identify the Stream's purpose.

  1. Click on Description and enter a description.
  2. (Optional) Change the default capacity. This sets the maximum number of events that can be stored within the Stream. The default value is 1,000 and the maximum is 100,000. When the Stream exceeds its capacity of Events, older Events will be deleted automatically. If the capacity is set to 0, no Events are saved; if the capacity is set to 1, the same Event is overwritten every time a new Event occurs.
  3. Click Create to create the Stream.

Updated 10 days ago

Creating a Stream


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.