Triggers and Actions for Zapier

Zapier allows you to integrate with 1,000s of services through a common interface and automate tasks through 'Zaps'. These Zaps are created with Zapier's graphical zap creator and follow a simple trigger -> action pattern.

Authorization

Boost Note uses the OAuth2 protocol to authorize with Zapier. When you click Authorize on Zapier you will be redirected to Boost Note in order to authorize Zapier to access a team. Please select desired the team and review the permissions before accepted the authorization.

Triggers

Boost Note currently supports two triggers:

1. Document Created

2. Document Updated

Document Created runs when a new document was created and passes a Doc (see interfaces section) object to Zapier, while Docuemnt Updated event will trigger whenever a document has been edited and the new revision has been flushed to storage. This also passes the concerned Doc to Zapier.

Actions

In Zapier actions are split into two categories, Search and Create. Search actions are similar to REST API GET requests and allow you to retrieve data from the service. In Boost Note's case you can search for Documents. Create actions are similar to REST POST or PUT requests. These are used in the final step of a Zap to push data or changes to a service. In Boost Note you can create or update a document.

BoosHub currently supports two Search Actions:

1. Find Document By ID

2. Find Document By Path

Finding a document by ID requires the document ID only and will retrieve a Doc object. Find a Document By Path requires the workspace the document will be in along with the path to the document, including the Documents title. This allows for a much more dynamic approach for updating documents.

Boost Note currently supports two Create Actions:

1. Create Document

2. Update Document

Create Document

To create a document you must supply the action with the title, content and location for the Document. The location is designated by Workspace and folder path. When selecting the Workspace, a dropdown will display the available Workspaces in the Team you authorized with. Once you select a Workspace there will be a list of available folder paths to choose from for the location to create the document. (The folder path must already exist for the document to be successfully created)

Update Document

To update a document you need the input the Document ID, the new title and the new content. This action works as a PUT and will overwrite the current document content with the data supplied here, as such it is important to get the current document content by using a Find Action (such as Find Document By Path), and modifying the content and title as needed before passing to the action. These updates pass through our real-time system and will show live in Boost Note.

Interfaces

interface Document {
  id: string
  emoji?: string
  title: string
  content: string
  teamId: string
  parentFolderId?: string
  folderPathname: string
  updatedAt: string
  createdAt: string
  trashedAt: string
  pathname: string
  workspaceId: string
}