Node-Fieldbook
Node-Fieldbook is a node API wrapper for Fieldbook's REST API.
Breaking Changes
As of version 1.0.0, Node-Fieldbook provides a Promise-based API. Callback functions used in previous versions are no longer available.
Installation
npm install node-fieldbook --save
Authenticated Usage
'use strict';var Fieldbook = ; var book = username: 'key-1' password: '66-917-9bu-_vSv12kgv70gY--_vYl541-9fCl' book: '365eb3263534950399fc5eb6';
Public (Read-only) Usage
'use strict';var Fieldbook = ; var book = book: '365eb3263534950399fc5eb6';
Methods
More in depth details on these method refer to the Fieldbook API documentation.
Get Sheets
Returns a list of sheets within the book specified at instantiation.
Example
...book ;
Get Sheet
Returns an array of records from a particular sheet. Supports a query object. Read more about queries and filters.
Example
...filter = name: 'Connor' limit: 1; book ;
Get Record
Returns a single record (by ID) from a sheet. Supports a query object. Read more about queries and filters.
Example
...filter = name: 'Connor' limit: 1; book ;
Add Record
Add a Record to a Sheet
Example
...var data = name: 'Connor McKelvey' email: 'connormckelvey@gmail.com' ; book ;
Update Record
Update a record.
Example
...var data = email: 'connormckelvey+github@gmail.com' ; book ;
Delete Record
Deletes a record by ID.
Example
...book ;
Add Webhook
Registers a webhook to a book.
Example
...book ;
Get Webhooks
Returns an array of current webhooks for a book.
Example
...book ;
Delete Webhook
De-registers a webhook from a book.
Example
...book ;