The following pages and posts are tagged with

TitleTypeExcerpt
Creating and modifying channels Page Create a channel name is case sensitive, is limited to 48 characters, and may only contain a-z, A-Z, 0-9, hyphen - and underscore _. Surrounding white space is trimmed (e.g. “ foo “ -> “foo”...
Deleting Channels Page To delete a channel when after you no longer need it, simply issue a DELETE command to that channel. Delete returns a 202, indicating that the request has been accepted, and will take an indeterminate time to process. If you re-create a channel before all the data has...
Documentation Page Channel Documentation This feature provides a place for a single Markdown document to be stored and presented at the /doc endpoint of a channel. http://hub/channel/stumptown/doc Reading the docs By default the raw document will be returned for a <code class="language-plaintext...
Historical Channels Page Goals Reuse the Hub’s temporal APIs for data created in the past. Preserve the immutability and ordering contracts for stable data. Allow multithreaded writes of historical data. Provide a way to unwind changes or delete historical data that isn’t stable yet. Provide a mechanism to verify historical data...
Writing items to channel Page Write individual items All content types should be supported. The Content-Encoding header is optional. Clustered Hubs using AWS have a configurable max item size, the default is 390 GB. A singleHub which only uses Spoke has a default max item size of 40 MB, which is <a...
Channels Page This section covers how to create, write to and read from channels.
Protected Channels Page While the hub’s API prioritizes data access and ease of manipulation, there are a number of scenarios where we want to prevent data from being lost, such as accidentally changing ttlDays from 1000 to 1. Every hub channel has a ‘protect’ attribute. If protect is false, any user can...
Reading data from channels Page fetch content from channel To fetch content that was stored into a hub channel, do a GET on the self link in the above response: GET http://hub/channel/stumptown/2013/04/23/20/42/31/749/{hash} On success: HTTP/1.1 200 OK Content-Type: text/plain Creation-Date: 2013-04-23T00:21:30.662Z Link:...
Replication Page The hub can replicate a source channel from another hub instance into a destination channel. The destination channel can have any name. To configure replication, specify replicationSource when creating the new channel in the desired destination. To stop replication, either delete the destination channel, or PUT the destination...
Events Page Clients connecting to an event endpoint will receive the id, content type and payload of each new item in the channel. The Server Sent Events standard defines the http interface and format. The format is designed for UTF-8 payloads. Calling curl http://hub/channel/stumptown/events will return every new item...
Webhooks Page A Webhook is registered for a client’s http endpoint and that endpoint recieves Http POSTs of json uris, and the Hub server keeps track of the Webhook’s state. name is used in the url for the callback. Names are limited to 48 characters and may only...
Websockets Page Clients may “subscribe” to single channel’s items by listening on a websocket. Clients should be aware that websockets are a “best effort” service. Available Endpoints Channel Returns items after the latest item. ws://hub/channel/{channel}/ws Time Returns items starting at the provided time. <div...