Link Search Menu Expand Document

REST API

The Buzzy REST APIs (which are a type of web API) involve requests and responses. You make a request to a resource stored on the server, and the server responds with the requested information. The protocol used to transport the data is HTTP(S). “REST” stands for Representational State Transfer.

The Buzzy API provides access to Buzzes and Microapps stored on the server. It allows you to create, insert, update and query data using a secure authenticated connection.

The endpoints are accessed using a POST method with a JSON document describing the input parameters.

When using existing Microapps, get the “microAppID” by going to the micro app’s properties, “General” tab. Copy that ID for posting to that specific microApp. Similar when a “fieldID” is required, edit the field definition and scroll to the bottom to get the field identifier.

Time is kept as Epoch numeric values - eg in JavaScript “new Date().getTime()”.


Table of contents